diff --git a/gems/bundled_gems b/gems/bundled_gems index dade781356..73407736bf 100644 --- a/gems/bundled_gems +++ b/gems/bundled_gems @@ -39,3 +39,4 @@ ostruct 0.6.1 https://github.com/ruby/ostruct pstore 0.1.4 https://github.com/ruby/pstore b563c4d354615e12a6fa54ffaa4ed711c3d1ba9f benchmark 0.4.0 https://github.com/ruby/benchmark logger 1.6.5 https://github.com/ruby/logger +rdoc 6.10.0 https://github.com/ruby/rdoc diff --git a/lib/rdoc.rb b/lib/rdoc.rb deleted file mode 100644 index b42059c712..0000000000 --- a/lib/rdoc.rb +++ /dev/null @@ -1,211 +0,0 @@ -# frozen_string_literal: true -$DEBUG_RDOC = nil - -## -# RDoc produces documentation for Ruby source files by parsing the source and -# extracting the definition for classes, modules, methods, includes and -# requires. It associates these with optional documentation contained in an -# immediately preceding comment block then renders the result using an output -# formatter. -# -# For a simple introduction to writing or generating documentation using RDoc -# see the README. -# -# == Roadmap -# -# If you think you found a bug in RDoc see CONTRIBUTING@Bugs -# -# If you want to use RDoc to create documentation for your Ruby source files, -# see RDoc::Markup and refer to rdoc --help for command line usage. -# -# If you want to set the default markup format see -# RDoc::Markup@Markup+Formats -# -# If you want to store rdoc configuration in your gem (such as the default -# markup format) see RDoc::Options@Saved+Options -# -# If you want to write documentation for Ruby files see RDoc::Parser::Ruby -# -# If you want to write documentation for extensions written in C see -# RDoc::Parser::C -# -# If you want to generate documentation using rake see RDoc::Task. -# -# If you want to drive RDoc programmatically, see RDoc::RDoc. -# -# If you want to use the library to format text blocks into HTML or other -# formats, look at RDoc::Markup. -# -# If you want to make an RDoc plugin such as a generator or directive handler -# see RDoc::RDoc. -# -# If you want to write your own output generator see RDoc::Generator. -# -# If you want an overview of how RDoc works see CONTRIBUTING -# -# == Credits -# -# RDoc is currently being maintained by Eric Hodel . -# -# Dave Thomas is the original author of RDoc. -# -# * The Ruby parser in rdoc/parse.rb is based heavily on the outstanding -# work of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby -# parser for irb and the rtags package. - -module RDoc - - ## - # Exception thrown by any rdoc error. - - class Error < RuntimeError; end - - require_relative 'rdoc/version' - - ## - # Method visibilities - - VISIBILITIES = [:public, :protected, :private] - - ## - # Name of the dotfile that contains the description of files to be processed - # in the current directory - - DOT_DOC_FILENAME = ".document" - - ## - # General RDoc modifiers - - GENERAL_MODIFIERS = %w[nodoc].freeze - - ## - # RDoc modifiers for classes - - CLASS_MODIFIERS = GENERAL_MODIFIERS - - ## - # RDoc modifiers for attributes - - ATTR_MODIFIERS = GENERAL_MODIFIERS - - ## - # RDoc modifiers for constants - - CONSTANT_MODIFIERS = GENERAL_MODIFIERS - - ## - # RDoc modifiers for methods - - METHOD_MODIFIERS = GENERAL_MODIFIERS + - %w[arg args yield yields notnew not-new not_new doc] - - ## - # Loads the best available YAML library. - - def self.load_yaml - begin - gem 'psych' - rescue NameError => e # --disable-gems - raise unless e.name == :gem - rescue Gem::LoadError - end - - begin - require 'psych' - rescue ::LoadError - ensure - require 'yaml' - end - end - - ## - # Searches and returns the directory for settings. - # - # 1. $HOME/.rdoc directory, if it exists. - # 2. The +rdoc+ directory under the path specified by the - # +XDG_DATA_HOME+ environment variable, if it is set. - # 3. $HOME/.local/share/rdoc directory. - # - # Other than the home directory, the containing directory will be - # created automatically. - - def self.home - rdoc_dir = begin - File.expand_path('~/.rdoc') - rescue ArgumentError - end - - if File.directory?(rdoc_dir) - rdoc_dir - else - require 'fileutils' - begin - # XDG - xdg_data_home = ENV["XDG_DATA_HOME"] || File.join(File.expand_path("~"), '.local', 'share') - unless File.exist?(xdg_data_home) - FileUtils.mkdir_p xdg_data_home - end - File.join xdg_data_home, "rdoc" - rescue Errno::EACCES - end - end - end - - autoload :RDoc, "#{__dir__}/rdoc/rdoc" - - autoload :CrossReference, "#{__dir__}/rdoc/cross_reference" - autoload :ERBIO, "#{__dir__}/rdoc/erbio" - autoload :ERBPartial, "#{__dir__}/rdoc/erb_partial" - autoload :Encoding, "#{__dir__}/rdoc/encoding" - autoload :Generator, "#{__dir__}/rdoc/generator" - autoload :Options, "#{__dir__}/rdoc/options" - autoload :Parser, "#{__dir__}/rdoc/parser" - autoload :Servlet, "#{__dir__}/rdoc/servlet" - autoload :RI, "#{__dir__}/rdoc/ri" - autoload :Stats, "#{__dir__}/rdoc/stats" - autoload :Store, "#{__dir__}/rdoc/store" - autoload :Task, "#{__dir__}/rdoc/task" - autoload :Text, "#{__dir__}/rdoc/text" - - autoload :Markdown, "#{__dir__}/rdoc/markdown" - autoload :Markup, "#{__dir__}/rdoc/markup" - autoload :RD, "#{__dir__}/rdoc/rd" - autoload :TomDoc, "#{__dir__}/rdoc/tom_doc" - - autoload :KNOWN_CLASSES, "#{__dir__}/rdoc/known_classes" - - autoload :TokenStream, "#{__dir__}/rdoc/token_stream" - - autoload :Comment, "#{__dir__}/rdoc/comment" - - require_relative 'rdoc/i18n' - - # code objects - # - # We represent the various high-level code constructs that appear in Ruby - # programs: classes, modules, methods, and so on. - autoload :CodeObject, "#{__dir__}/rdoc/code_object" - - autoload :Context, "#{__dir__}/rdoc/code_object/context" - autoload :TopLevel, "#{__dir__}/rdoc/code_object/top_level" - - autoload :AnonClass, "#{__dir__}/rdoc/code_object/anon_class" - autoload :ClassModule, "#{__dir__}/rdoc/code_object/class_module" - autoload :NormalClass, "#{__dir__}/rdoc/code_object/normal_class" - autoload :NormalModule, "#{__dir__}/rdoc/code_object/normal_module" - autoload :SingleClass, "#{__dir__}/rdoc/code_object/single_class" - - autoload :Alias, "#{__dir__}/rdoc/code_object/alias" - autoload :AnyMethod, "#{__dir__}/rdoc/code_object/any_method" - autoload :MethodAttr, "#{__dir__}/rdoc/code_object/method_attr" - autoload :GhostMethod, "#{__dir__}/rdoc/code_object/ghost_method" - autoload :MetaMethod, "#{__dir__}/rdoc/code_object/meta_method" - autoload :Attr, "#{__dir__}/rdoc/code_object/attr" - - autoload :Constant, "#{__dir__}/rdoc/code_object/constant" - autoload :Mixin, "#{__dir__}/rdoc/code_object/mixin" - autoload :Include, "#{__dir__}/rdoc/code_object/include" - autoload :Extend, "#{__dir__}/rdoc/code_object/extend" - autoload :Require, "#{__dir__}/rdoc/code_object/require" - -end diff --git a/lib/rdoc/code_object.rb b/lib/rdoc/code_object.rb deleted file mode 100644 index 83997c2580..0000000000 --- a/lib/rdoc/code_object.rb +++ /dev/null @@ -1,427 +0,0 @@ -# frozen_string_literal: true -## -# Base class for the RDoc code tree. -# -# We contain the common stuff for contexts (which are containers) and other -# elements (methods, attributes and so on) -# -# Here's the tree of the CodeObject subclasses: -# -# * RDoc::Context -# * RDoc::TopLevel -# * RDoc::ClassModule -# * RDoc::AnonClass (never used so far) -# * RDoc::NormalClass -# * RDoc::NormalModule -# * RDoc::SingleClass -# * RDoc::MethodAttr -# * RDoc::Attr -# * RDoc::AnyMethod -# * RDoc::GhostMethod -# * RDoc::MetaMethod -# * RDoc::Alias -# * RDoc::Constant -# * RDoc::Mixin -# * RDoc::Require -# * RDoc::Include - -class RDoc::CodeObject - - include RDoc::Text - - ## - # Our comment - - attr_reader :comment - - ## - # Do we document our children? - - attr_reader :document_children - - ## - # Do we document ourselves? - - attr_reader :document_self - - ## - # Are we done documenting (ie, did we come across a :enddoc:)? - - attr_reader :done_documenting - - ## - # Which file this code object was defined in - - attr_reader :file - - ## - # Force documentation of this CodeObject - - attr_reader :force_documentation - - ## - # Line in #file where this CodeObject was defined - - attr_accessor :line - - ## - # Hash of arbitrary metadata for this CodeObject - - attr_reader :metadata - - ## - # Sets the parent CodeObject - - attr_writer :parent - - ## - # Did we ever receive a +:nodoc:+ directive? - - attr_reader :received_nodoc - - ## - # Set the section this CodeObject is in - - attr_writer :section - - ## - # The RDoc::Store for this object. - - attr_reader :store - - ## - # We are the model of the code, but we know that at some point we will be - # worked on by viewers. By implementing the Viewable protocol, viewers can - # associated themselves with these objects. - - attr_accessor :viewer - - ## - # When mixed-in to a class, this points to the Context in which it was originally defined. - - attr_accessor :mixin_from - - ## - # Creates a new CodeObject that will document itself and its children - - def initialize - @metadata = {} - @comment = '' - @parent = nil - @parent_name = nil # for loading - @parent_class = nil # for loading - @section = nil - @section_title = nil # for loading - @file = nil - @full_name = nil - @store = nil - @track_visibility = true - @mixin_from = nil - - initialize_visibility - end - - ## - # Initializes state for visibility of this CodeObject and its children. - - def initialize_visibility # :nodoc: - @document_children = true - @document_self = true - @done_documenting = false - @force_documentation = false - @received_nodoc = false - @ignored = false - @suppressed = false - @track_visibility = true - end - - ## - # Replaces our comment with +comment+, unless it is empty. - - def comment=(comment) - @comment = case comment - when NilClass then '' - when RDoc::Markup::Document then comment - when RDoc::Comment then comment.normalize - else - if comment and not comment.empty? then - normalize_comment comment - else - # HACK correct fix is to have #initialize create @comment - # with the correct encoding - if String === @comment and @comment.empty? then - @comment = RDoc::Encoding.change_encoding @comment, comment.encoding - end - @comment - end - end - end - - ## - # Should this CodeObject be displayed in output? - # - # A code object should be displayed if: - # - # * The item didn't have a nodoc or wasn't in a container that had nodoc - # * The item wasn't ignored - # * The item has documentation and was not suppressed - - def display? - @document_self and not @ignored and - (documented? or not @suppressed) - end - - ## - # Enables or disables documentation of this CodeObject's children unless it - # has been turned off by :enddoc: - - def document_children=(document_children) - return unless @track_visibility - - @document_children = document_children unless @done_documenting - end - - ## - # Enables or disables documentation of this CodeObject unless it has been - # turned off by :enddoc:. If the argument is +nil+ it means the - # documentation is turned off by +:nodoc:+. - - def document_self=(document_self) - return unless @track_visibility - return if @done_documenting - - @document_self = document_self - @received_nodoc = true if document_self.nil? - end - - ## - # Does this object have a comment with content or is #received_nodoc true? - - def documented? - @received_nodoc or !@comment.empty? - end - - ## - # Turns documentation on/off, and turns on/off #document_self - # and #document_children. - # - # Once documentation has been turned off (by +:enddoc:+), - # the object will refuse to turn #document_self or - # #document_children on, so +:doc:+ and +:start_doc:+ directives - # will have no effect in the current file. - - def done_documenting=(value) - return unless @track_visibility - @done_documenting = value - @document_self = !value - @document_children = @document_self - end - - ## - # Yields each parent of this CodeObject. See also - # RDoc::ClassModule#each_ancestor - - def each_parent - code_object = self - - while code_object = code_object.parent do - yield code_object - end - - self - end - - ## - # File name where this CodeObject was found. - # - # See also RDoc::Context#in_files - - def file_name - return unless @file - - @file.absolute_name - end - - ## - # Force the documentation of this object unless documentation - # has been turned off by :enddoc: - #-- - # HACK untested, was assigning to an ivar - - def force_documentation=(value) - @force_documentation = value unless @done_documenting - end - - ## - # Sets the full_name overriding any computed full name. - # - # Set to +nil+ to clear RDoc's cached value - - def full_name= full_name - @full_name = full_name - end - - ## - # Use this to ignore a CodeObject and all its children until found again - # (#record_location is called). An ignored item will not be displayed in - # documentation. - # - # See github issue #55 - # - # The ignored status is temporary in order to allow implementation details - # to be hidden. At the end of processing a file RDoc allows all classes - # and modules to add new documentation to previously created classes. - # - # If a class was ignored (via stopdoc) then reopened later with additional - # documentation it should be displayed. If a class was ignored and never - # reopened it should not be displayed. The ignore flag allows this to - # occur. - - def ignore - return unless @track_visibility - - @ignored = true - - stop_doc - end - - ## - # Has this class been ignored? - # - # See also #ignore - - def ignored? - @ignored - end - - ## - # The options instance from the store this CodeObject is attached to, or a - # default options instance if the CodeObject is not attached. - # - # This is used by Text#snippet - - def options - if @store and @store.rdoc then - @store.rdoc.options - else - RDoc::Options.new - end - end - - ## - # Our parent CodeObject. The parent may be missing for classes loaded from - # legacy RI data stores. - - def parent - return @parent if @parent - return nil unless @parent_name - - if @parent_class == RDoc::TopLevel then - @parent = @store.add_file @parent_name - else - @parent = @store.find_class_or_module @parent_name - - return @parent if @parent - - begin - @parent = @store.load_class @parent_name - rescue RDoc::Store::MissingFileError - nil - end - end - end - - ## - # File name of our parent - - def parent_file_name - @parent ? @parent.base_name : '(unknown)' - end - - ## - # Name of our parent - - def parent_name - @parent ? @parent.full_name : '(unknown)' - end - - ## - # Records the RDoc::TopLevel (file) where this code object was defined - - def record_location top_level - @ignored = false - @suppressed = false - @file = top_level - end - - ## - # The section this CodeObject is in. Sections allow grouping of constants, - # attributes and methods inside a class or module. - - def section - return @section if @section - - @section = parent.add_section @section_title if parent - end - - ## - # Enable capture of documentation unless documentation has been - # turned off by :enddoc: - - def start_doc - return if @done_documenting - - @document_self = true - @document_children = true - @ignored = false - @suppressed = false - end - - ## - # Disable capture of documentation - - def stop_doc - return unless @track_visibility - - @document_self = false - @document_children = false - end - - ## - # Sets the +store+ that contains this CodeObject - - def store= store - @store = store - - return unless @track_visibility - - if :nodoc == options.visibility then - initialize_visibility - @track_visibility = false - end - end - - ## - # Use this to suppress a CodeObject and all its children until the next file - # it is seen in or documentation is discovered. A suppressed item with - # documentation will be displayed while an ignored item with documentation - # may not be displayed. - - def suppress - return unless @track_visibility - - @suppressed = true - - stop_doc - end - - ## - # Has this class been suppressed? - # - # See also #suppress - - def suppressed? - @suppressed - end - -end diff --git a/lib/rdoc/code_object/alias.rb b/lib/rdoc/code_object/alias.rb deleted file mode 100644 index 92df7e448f..0000000000 --- a/lib/rdoc/code_object/alias.rb +++ /dev/null @@ -1,111 +0,0 @@ -# frozen_string_literal: true -## -# Represent an alias, which is an old_name/new_name pair associated with a -# particular context -#-- -# TODO implement Alias as a proxy to a method/attribute, inheriting from -# MethodAttr - -class RDoc::Alias < RDoc::CodeObject - - ## - # Aliased method's name - - attr_reader :new_name - - alias name new_name - - ## - # Aliasee method's name - - attr_reader :old_name - - ## - # Is this an alias declared in a singleton context? - - attr_accessor :singleton - - ## - # Source file token stream - - attr_reader :text - - ## - # Creates a new Alias with a token stream of +text+ that aliases +old_name+ - # to +new_name+, has +comment+ and is a +singleton+ context. - - def initialize(text, old_name, new_name, comment, singleton = false) - super() - - @text = text - @singleton = singleton - @old_name = old_name - @new_name = new_name - self.comment = comment - end - - ## - # Order by #singleton then #new_name - - def <=>(other) - [@singleton ? 0 : 1, new_name] <=> [other.singleton ? 0 : 1, other.new_name] - end - - ## - # HTML fragment reference for this alias - - def aref - type = singleton ? 'c' : 'i' - "#alias-#{type}-#{html_name}" - end - - ## - # Full old name including namespace - - def full_old_name - @full_name || "#{parent.name}#{pretty_old_name}" - end - - ## - # HTML id-friendly version of +#new_name+. - - def html_name - CGI.escape(@new_name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '') - end - - def inspect # :nodoc: - parent_name = parent ? parent.name : '(unknown)' - "#<%s:0x%x %s.alias_method %s, %s>" % [ - self.class, object_id, - parent_name, @old_name, @new_name, - ] - end - - ## - # '::' for the alias of a singleton method/attribute, '#' for instance-level. - - def name_prefix - singleton ? '::' : '#' - end - - ## - # Old name with prefix '::' or '#'. - - def pretty_old_name - "#{singleton ? '::' : '#'}#{@old_name}" - end - - ## - # New name with prefix '::' or '#'. - - def pretty_new_name - "#{singleton ? '::' : '#'}#{@new_name}" - end - - alias pretty_name pretty_new_name - - def to_s # :nodoc: - "alias: #{self.new_name} -> #{self.pretty_old_name} in: #{parent}" - end - -end diff --git a/lib/rdoc/code_object/anon_class.rb b/lib/rdoc/code_object/anon_class.rb deleted file mode 100644 index 3c2f0e1877..0000000000 --- a/lib/rdoc/code_object/anon_class.rb +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true -## -# An anonymous class like: -# -# c = Class.new do end -# -# AnonClass is currently not used. - -class RDoc::AnonClass < RDoc::ClassModule -end diff --git a/lib/rdoc/code_object/any_method.rb b/lib/rdoc/code_object/any_method.rb deleted file mode 100644 index 465c4a4fb2..0000000000 --- a/lib/rdoc/code_object/any_method.rb +++ /dev/null @@ -1,379 +0,0 @@ -# frozen_string_literal: true -## -# AnyMethod is the base class for objects representing methods - -class RDoc::AnyMethod < RDoc::MethodAttr - - ## - # 2:: - # RDoc 4 - # Added calls_super - # Added parent name and class - # Added section title - # 3:: - # RDoc 4.1 - # Added is_alias_for - - MARSHAL_VERSION = 3 # :nodoc: - - ## - # Don't rename \#initialize to \::new - - attr_accessor :dont_rename_initialize - - ## - # The C function that implements this method (if it was defined in a C file) - - attr_accessor :c_function - - # The section title of the method (if defined in a C file via +:category:+) - attr_accessor :section_title - - # Parameters for this method - - attr_accessor :params - - ## - # If true this method uses +super+ to call a superclass version - - attr_accessor :calls_super - - include RDoc::TokenStream - - ## - # Creates a new AnyMethod with a token stream +text+ and +name+ - - def initialize text, name - super - - @c_function = nil - @dont_rename_initialize = false - @token_stream = nil - @calls_super = false - @superclass_method = nil - end - - ## - # Adds +an_alias+ as an alias for this method in +context+. - - def add_alias an_alias, context = nil - method = self.class.new an_alias.text, an_alias.new_name - - method.record_location an_alias.file - method.singleton = self.singleton - method.params = self.params - method.visibility = self.visibility - method.comment = an_alias.comment - method.is_alias_for = self - @aliases << method - context.add_method method if context - method - end - - ## - # Prefix for +aref+ is 'method'. - - def aref_prefix - 'method' - end - - ## - # The call_seq or the param_seq with method name, if there is no call_seq. - # - # Use this for displaying a method's argument lists. - - def arglists - if @call_seq then - @call_seq - elsif @params then - "#{name}#{param_seq}" - end - end - - ## - # Different ways to call this method - - def call_seq - unless call_seq = _call_seq - call_seq = is_alias_for._call_seq if is_alias_for - end - - return unless call_seq - - deduplicate_call_seq(call_seq) - end - - ## - # Sets the different ways you can call this method. If an empty +call_seq+ - # is given nil is assumed. - # - # See also #param_seq - - def call_seq= call_seq - return if call_seq.empty? - - @call_seq = call_seq - end - - ## - # Whether the method has a call-seq. - - def has_call_seq? - !!(@call_seq || is_alias_for&._call_seq) - end - - ## - # Loads is_alias_for from the internal name. Returns nil if the alias - # cannot be found. - - def is_alias_for # :nodoc: - case @is_alias_for - when RDoc::MethodAttr then - @is_alias_for - when Array then - return nil unless @store - - klass_name, singleton, method_name = @is_alias_for - - return nil unless klass = @store.find_class_or_module(klass_name) - - @is_alias_for = klass.find_method method_name, singleton - end - end - - ## - # Dumps this AnyMethod for use by ri. See also #marshal_load - - def marshal_dump - aliases = @aliases.map do |a| - [a.name, parse(a.comment)] - end - - is_alias_for = [ - @is_alias_for.parent.full_name, - @is_alias_for.singleton, - @is_alias_for.name - ] if @is_alias_for - - [ MARSHAL_VERSION, - @name, - full_name, - @singleton, - @visibility, - parse(@comment), - @call_seq, - @block_params, - aliases, - @params, - @file.relative_name, - @calls_super, - @parent.name, - @parent.class, - @section.title, - is_alias_for, - ] - end - - ## - # Loads this AnyMethod from +array+. For a loaded AnyMethod the following - # methods will return cached values: - # - # * #full_name - # * #parent_name - - def marshal_load array - initialize_visibility - - @dont_rename_initialize = nil - @token_stream = nil - @aliases = [] - @parent = nil - @parent_name = nil - @parent_class = nil - @section = nil - @file = nil - - version = array[0] - @name = array[1] - @full_name = array[2] - @singleton = array[3] - @visibility = array[4] - @comment = array[5] - @call_seq = array[6] - @block_params = array[7] - # 8 handled below - @params = array[9] - # 10 handled below - @calls_super = array[11] - @parent_name = array[12] - @parent_title = array[13] - @section_title = array[14] - @is_alias_for = array[15] - - array[8].each do |new_name, comment| - add_alias RDoc::Alias.new(nil, @name, new_name, comment, @singleton) - end - - @parent_name ||= if @full_name =~ /#/ then - $` - else - name = @full_name.split('::') - name.pop - name.join '::' - end - - @file = RDoc::TopLevel.new array[10] if version > 0 - end - - ## - # Method name - # - # If the method has no assigned name, it extracts it from #call_seq. - - def name - return @name if @name - - @name = - @call_seq[/^.*?\.(\w+)/, 1] || - @call_seq[/^.*?(\w+)/, 1] || - @call_seq if @call_seq - end - - ## - # A list of this method's method and yield parameters. +call-seq+ params - # are preferred over parsed method and block params. - - def param_list - if @call_seq then - params = @call_seq.split("\n").last - params = params.sub(/.*?\((.*)\)/, '\1') - params = params.sub(/(\{|do)\s*\|([^|]*)\|.*/, ',\2') - elsif @params then - params = @params.sub(/\((.*)\)/, '\1') - - params << ",#{@block_params}" if @block_params - elsif @block_params then - params = @block_params - else - return [] - end - - if @block_params then - # If this method has explicit block parameters, remove any explicit - # &block - params = params.sub(/,?\s*&\w+/, '') - else - params = params.sub(/\&(\w+)/, '\1') - end - - params = params.gsub(/\s+/, '').split(',').reject(&:empty?) - - params.map { |param| param.sub(/=.*/, '') } - end - - ## - # Pretty parameter list for this method. If the method's parameters were - # given by +call-seq+ it is preferred over the parsed values. - - def param_seq - if @call_seq then - params = @call_seq.split("\n").last - params = params.sub(/[^( ]+/, '') - params = params.sub(/(\|[^|]+\|)\s*\.\.\.\s*(end|\})/, '\1 \2') - elsif @params then - params = @params.gsub(/\s*\#.*/, '') - params = params.tr_s("\n ", " ") - params = "(#{params})" unless params[0] == ?( - else - params = '' - end - - if @block_params then - # If this method has explicit block parameters, remove any explicit - # &block - params = params.sub(/,?\s*&\w+/, '') - - block = @block_params.tr_s("\n ", " ") - if block[0] == ?( - block = block.sub(/^\(/, '').sub(/\)/, '') - end - params << " { |#{block}| ... }" - end - - params - end - - ## - # Whether to skip the method description, true for methods that have - # aliases with a call-seq that doesn't include the method name. - - def skip_description? - has_call_seq? && call_seq.nil? && !!(is_alias_for || !aliases.empty?) - end - - ## - # Sets the store for this method and its referenced code objects. - - def store= store - super - - @file = @store.add_file @file.full_name if @file - end - - ## - # For methods that +super+, find the superclass method that would be called. - - def superclass_method - return unless @calls_super - return @superclass_method if @superclass_method - - parent.each_ancestor do |ancestor| - if method = ancestor.method_list.find { |m| m.name == @name } then - @superclass_method = method - break - end - end - - @superclass_method - end - - protected - - ## - # call_seq without deduplication and alias lookup. - - def _call_seq - @call_seq if defined?(@call_seq) && @call_seq - end - - private - - ## - # call_seq with alias examples information removed, if this - # method is an alias method. - - def deduplicate_call_seq(call_seq) - return call_seq unless is_alias_for || !aliases.empty? - - method_name = self.name - method_name = method_name[0, 1] if method_name =~ /\A\[/ - - entries = call_seq.split "\n" - - ignore = aliases.map(&:name) - if is_alias_for - ignore << is_alias_for.name - ignore.concat is_alias_for.aliases.map(&:name) - end - ignore.map! { |n| n =~ /\A\[/ ? /\[.*\]/ : n} - ignore.delete(method_name) - ignore = Regexp.union(ignore) - - matching = entries.reject do |entry| - entry =~ /^\w*\.?#{ignore}[$\(\s]/ or - entry =~ /\s#{ignore}\s/ - end - - matching.empty? ? nil : matching.join("\n") - end -end diff --git a/lib/rdoc/code_object/attr.rb b/lib/rdoc/code_object/attr.rb deleted file mode 100644 index a403235933..0000000000 --- a/lib/rdoc/code_object/attr.rb +++ /dev/null @@ -1,175 +0,0 @@ -# frozen_string_literal: true -## -# An attribute created by \#attr, \#attr_reader, \#attr_writer or -# \#attr_accessor - -class RDoc::Attr < RDoc::MethodAttr - - ## - # 3:: - # RDoc 4 - # Added parent name and class - # Added section title - - MARSHAL_VERSION = 3 # :nodoc: - - ## - # Is the attribute readable ('R'), writable ('W') or both ('RW')? - - attr_accessor :rw - - ## - # Creates a new Attr with body +text+, +name+, read/write status +rw+ and - # +comment+. +singleton+ marks this as a class attribute. - - def initialize(text, name, rw, comment, singleton = false) - super text, name - - @rw = rw - @singleton = singleton - self.comment = comment - end - - ## - # Attributes are equal when their names, singleton and rw are identical - - def == other - self.class == other.class and - self.name == other.name and - self.rw == other.rw and - self.singleton == other.singleton - end - - ## - # Add +an_alias+ as an attribute in +context+. - - def add_alias(an_alias, context) - new_attr = self.class.new(self.text, an_alias.new_name, self.rw, - self.comment, self.singleton) - - new_attr.record_location an_alias.file - new_attr.visibility = self.visibility - new_attr.is_alias_for = self - @aliases << new_attr - context.add_attribute new_attr - new_attr - end - - ## - # The #aref prefix for attributes - - def aref_prefix - 'attribute' - end - - ## - # Attributes never call super. See RDoc::AnyMethod#calls_super - # - # An RDoc::Attr can show up in the method list in some situations (see - # Gem::ConfigFile) - - def calls_super # :nodoc: - false - end - - ## - # Returns attr_reader, attr_writer or attr_accessor as appropriate. - - def definition - case @rw - when 'RW' then 'attr_accessor' - when 'R' then 'attr_reader' - when 'W' then 'attr_writer' - end - end - - def inspect # :nodoc: - alias_for = @is_alias_for ? " (alias for #{@is_alias_for.name})" : nil - visibility = self.visibility - visibility = "forced #{visibility}" if force_documentation - "#<%s:0x%x %s %s (%s)%s>" % [ - self.class, object_id, - full_name, - rw, - visibility, - alias_for, - ] - end - - ## - # Dumps this Attr for use by ri. See also #marshal_load - - def marshal_dump - [ MARSHAL_VERSION, - @name, - full_name, - @rw, - @visibility, - parse(@comment), - singleton, - @file.relative_name, - @parent.full_name, - @parent.class, - @section.title - ] - end - - ## - # Loads this Attr from +array+. For a loaded Attr the following - # methods will return cached values: - # - # * #full_name - # * #parent_name - - def marshal_load array - initialize_visibility - - @aliases = [] - @parent = nil - @parent_name = nil - @parent_class = nil - @section = nil - @file = nil - - version = array[0] - @name = array[1] - @full_name = array[2] - @rw = array[3] - @visibility = array[4] - @comment = array[5] - @singleton = array[6] || false # MARSHAL_VERSION == 0 - # 7 handled below - @parent_name = array[8] - @parent_class = array[9] - @section_title = array[10] - - @file = RDoc::TopLevel.new array[7] if version > 1 - - @parent_name ||= @full_name.split('#', 2).first - end - - def pretty_print q # :nodoc: - q.group 2, "[#{self.class.name} #{full_name} #{rw} #{visibility}", "]" do - unless comment.empty? then - q.breakable - q.text "comment:" - q.breakable - q.pp @comment - end - end - end - - def to_s # :nodoc: - "#{definition} #{name} in: #{parent}" - end - - ## - # Attributes do not have token streams. - # - # An RDoc::Attr can show up in the method list in some situations (see - # Gem::ConfigFile) - - def token_stream # :nodoc: - end - -end diff --git a/lib/rdoc/code_object/class_module.rb b/lib/rdoc/code_object/class_module.rb deleted file mode 100644 index 33e71ab3f3..0000000000 --- a/lib/rdoc/code_object/class_module.rb +++ /dev/null @@ -1,868 +0,0 @@ -# frozen_string_literal: true -## -# ClassModule is the base class for objects representing either a class or a -# module. - -class RDoc::ClassModule < RDoc::Context - - ## - # 1:: - # RDoc 3.7 - # * Added visibility, singleton and file to attributes - # * Added file to constants - # * Added file to includes - # * Added file to methods - # 2:: - # RDoc 3.13 - # * Added extends - # 3:: - # RDoc 4.0 - # * Added sections - # * Added in_files - # * Added parent name - # * Complete Constant dump - - MARSHAL_VERSION = 3 # :nodoc: - - ## - # Constants that are aliases for this class or module - - attr_accessor :constant_aliases - - ## - # Comment and the location it came from. Use #add_comment to add comments - - attr_accessor :comment_location - - attr_accessor :diagram # :nodoc: - - ## - # Class or module this constant is an alias for - - attr_accessor :is_alias_for - - ## - # Return a RDoc::ClassModule of class +class_type+ that is a copy - # of module +module+. Used to promote modules to classes. - #-- - # TODO move to RDoc::NormalClass (I think) - - def self.from_module class_type, mod - klass = class_type.new mod.name - - mod.comment_location.each do |comment, location| - klass.add_comment comment, location - end - - klass.parent = mod.parent - klass.section = mod.section - klass.viewer = mod.viewer - - klass.attributes.concat mod.attributes - klass.method_list.concat mod.method_list - klass.aliases.concat mod.aliases - klass.external_aliases.concat mod.external_aliases - klass.constants.concat mod.constants - klass.includes.concat mod.includes - klass.extends.concat mod.extends - - klass.methods_hash.update mod.methods_hash - klass.constants_hash.update mod.constants_hash - - klass.current_section = mod.current_section - klass.in_files.concat mod.in_files - klass.sections.concat mod.sections - klass.unmatched_alias_lists = mod.unmatched_alias_lists - klass.current_section = mod.current_section - klass.visibility = mod.visibility - - klass.classes_hash.update mod.classes_hash - klass.modules_hash.update mod.modules_hash - klass.metadata.update mod.metadata - - klass.document_self = mod.received_nodoc ? nil : mod.document_self - klass.document_children = mod.document_children - klass.force_documentation = mod.force_documentation - klass.done_documenting = mod.done_documenting - - # update the parent of all children - - (klass.attributes + - klass.method_list + - klass.aliases + - klass.external_aliases + - klass.constants + - klass.includes + - klass.extends + - klass.classes + - klass.modules).each do |obj| - obj.parent = klass - obj.full_name = nil - end - - klass - end - - ## - # Creates a new ClassModule with +name+ with optional +superclass+ - # - # This is a constructor for subclasses, and must never be called directly. - - def initialize(name, superclass = nil) - @constant_aliases = [] - @diagram = nil - @is_alias_for = nil - @name = name - @superclass = superclass - @comment_location = [] # [[comment, location]] - - super() - end - - ## - # Adds +comment+ to this ClassModule's list of comments at +location+. This - # method is preferred over #comment= since it allows ri data to be updated - # across multiple runs. - - def add_comment comment, location - return unless document_self - - original = comment - - comment = case comment - when RDoc::Comment then - comment.normalize - else - normalize_comment comment - end - - if location.parser == RDoc::Parser::C - @comment_location.delete_if { |(_, l)| l == location } - end - - @comment_location << [comment, location] - - self.comment = original - end - - def add_things my_things, other_things # :nodoc: - other_things.each do |group, things| - my_things[group].each { |thing| yield false, thing } if - my_things.include? group - - things.each do |thing| - yield true, thing - end - end - end - - ## - # Ancestors list for this ClassModule: the list of included modules - # (classes will add their superclass if any). - # - # Returns the included classes or modules, not the includes - # themselves. The returned values are either String or - # RDoc::NormalModule instances (see RDoc::Include#module). - # - # The values are returned in reverse order of their inclusion, - # which is the order suitable for searching methods/attributes - # in the ancestors. The superclass, if any, comes last. - - def ancestors - includes.map { |i| i.module }.reverse - end - - def aref_prefix # :nodoc: - raise NotImplementedError, "missing aref_prefix for #{self.class}" - end - - ## - # HTML fragment reference for this module or class. See - # RDoc::NormalClass#aref and RDoc::NormalModule#aref - - def aref - "#{aref_prefix}-#{full_name}" - end - - ## - # Ancestors of this class or module only - - alias direct_ancestors ancestors - - ## - # Clears the comment. Used by the Ruby parser. - - def clear_comment - @comment = '' - end - - ## - # This method is deprecated, use #add_comment instead. - # - # Appends +comment+ to the current comment, but separated by a rule. Works - # more like +=. - - def comment= comment # :nodoc: - comment = case comment - when RDoc::Comment then - comment.normalize - else - normalize_comment comment - end - - comment = "#{@comment.to_s}\n---\n#{comment.to_s}" unless @comment.empty? - - super comment - end - - ## - # Prepares this ClassModule for use by a generator. - # - # See RDoc::Store#complete - - def complete min_visibility - update_aliases - remove_nodoc_children - embed_mixins - update_includes - remove_invisible min_visibility - end - - ## - # Does this ClassModule or any of its methods have document_self set? - - def document_self_or_methods - document_self || method_list.any?{ |m| m.document_self } - end - - ## - # Does this class or module have a comment with content or is - # #received_nodoc true? - - def documented? - return true if @received_nodoc - return false if @comment_location.empty? - @comment_location.any? { |comment, _| not comment.empty? } - end - - ## - # Iterates the ancestors of this class or module for which an - # RDoc::ClassModule exists. - - def each_ancestor # :yields: module - return enum_for __method__ unless block_given? - - ancestors.each do |mod| - next if String === mod - next if self == mod - yield mod - end - end - - ## - # Looks for a symbol in the #ancestors. See Context#find_local_symbol. - - def find_ancestor_local_symbol symbol - each_ancestor do |m| - res = m.find_local_symbol(symbol) - return res if res - end - - nil - end - - ## - # Finds a class or module with +name+ in this namespace or its descendants - - def find_class_named name - return self if full_name == name - return self if @name == name - - @classes.values.find do |klass| - next if klass == self - klass.find_class_named name - end - end - - ## - # Return the fully qualified name of this class or module - - def full_name - @full_name ||= if RDoc::ClassModule === parent then - "#{parent.full_name}::#{@name}" - else - @name - end - end - - ## - # TODO: filter included items by #display? - - def marshal_dump # :nodoc: - attrs = attributes.sort.map do |attr| - next unless attr.display? - [ attr.name, attr.rw, - attr.visibility, attr.singleton, attr.file_name, - ] - end.compact - - method_types = methods_by_type.map do |type, visibilities| - visibilities = visibilities.map do |visibility, methods| - method_names = methods.map do |method| - next unless method.display? - [method.name, method.file_name] - end.compact - - [visibility, method_names.uniq] - end - - [type, visibilities] - end - - [ MARSHAL_VERSION, - @name, - full_name, - @superclass, - parse(@comment_location), - attrs, - constants.select { |constant| constant.display? }, - includes.map do |incl| - next unless incl.display? - [incl.name, parse(incl.comment), incl.file_name] - end.compact, - method_types, - extends.map do |ext| - next unless ext.display? - [ext.name, parse(ext.comment), ext.file_name] - end.compact, - @sections.values, - @in_files.map do |tl| - tl.relative_name - end, - parent.full_name, - parent.class, - ] - end - - def marshal_load array # :nodoc: - initialize_visibility - initialize_methods_etc - @current_section = nil - @document_self = true - @done_documenting = false - @parent = nil - @temporary_section = nil - @visibility = nil - @classes = {} - @modules = {} - - @name = array[1] - @full_name = array[2] - @superclass = array[3] - @comment = array[4] - - @comment_location = if RDoc::Markup::Document === @comment.parts.first then - @comment - else - RDoc::Markup::Document.new @comment - end - - array[5].each do |name, rw, visibility, singleton, file| - singleton ||= false - visibility ||= :public - - attr = RDoc::Attr.new nil, name, rw, nil, singleton - - add_attribute attr - attr.visibility = visibility - attr.record_location RDoc::TopLevel.new file - end - - array[6].each do |constant, comment, file| - case constant - when RDoc::Constant then - add_constant constant - else - constant = add_constant RDoc::Constant.new(constant, nil, comment) - constant.record_location RDoc::TopLevel.new file - end - end - - array[7].each do |name, comment, file| - incl = add_include RDoc::Include.new(name, comment) - incl.record_location RDoc::TopLevel.new file - end - - array[8].each do |type, visibilities| - visibilities.each do |visibility, methods| - @visibility = visibility - - methods.each do |name, file| - method = RDoc::AnyMethod.new nil, name - method.singleton = true if type == 'class' - method.record_location RDoc::TopLevel.new file - add_method method - end - end - end - - array[9].each do |name, comment, file| - ext = add_extend RDoc::Extend.new(name, comment) - ext.record_location RDoc::TopLevel.new file - end if array[9] # Support Marshal version 1 - - sections = (array[10] || []).map do |section| - [section.title, section] - end - - @sections = Hash[*sections.flatten] - @current_section = add_section nil - - @in_files = [] - - (array[11] || []).each do |filename| - record_location RDoc::TopLevel.new filename - end - - @parent_name = array[12] - @parent_class = array[13] - end - - ## - # Merges +class_module+ into this ClassModule. - # - # The data in +class_module+ is preferred over the receiver. - - def merge class_module - @parent = class_module.parent - @parent_name = class_module.parent_name - - other_document = parse class_module.comment_location - - if other_document then - document = parse @comment_location - - document = document.merge other_document - - @comment = @comment_location = document - end - - cm = class_module - other_files = cm.in_files - - merge_collections attributes, cm.attributes, other_files do |add, attr| - if add then - add_attribute attr - else - @attributes.delete attr - @methods_hash.delete attr.pretty_name - end - end - - merge_collections constants, cm.constants, other_files do |add, const| - if add then - add_constant const - else - @constants.delete const - @constants_hash.delete const.name - end - end - - merge_collections includes, cm.includes, other_files do |add, incl| - if add then - add_include incl - else - @includes.delete incl - end - end - - @includes.uniq! # clean up - - merge_collections extends, cm.extends, other_files do |add, ext| - if add then - add_extend ext - else - @extends.delete ext - end - end - - @extends.uniq! # clean up - - merge_collections method_list, cm.method_list, other_files do |add, meth| - if add then - add_method meth - else - @method_list.delete meth - @methods_hash.delete meth.pretty_name - end - end - - merge_sections cm - - self - end - - ## - # Merges collection +mine+ with +other+ preferring other. +other_files+ is - # used to help determine which items should be deleted. - # - # Yields whether the item should be added or removed (true or false) and the - # item to be added or removed. - # - # merge_collections things, other.things, other.in_files do |add, thing| - # if add then - # # add the thing - # else - # # remove the thing - # end - # end - - def merge_collections mine, other, other_files, &block # :nodoc: - my_things = mine. group_by { |thing| thing.file } - other_things = other.group_by { |thing| thing.file } - - remove_things my_things, other_files, &block - add_things my_things, other_things, &block - end - - ## - # Merges the comments in this ClassModule with the comments in the other - # ClassModule +cm+. - - def merge_sections cm # :nodoc: - my_sections = sections.group_by { |section| section.title } - other_sections = cm.sections.group_by { |section| section.title } - - other_files = cm.in_files - - remove_things my_sections, other_files do |_, section| - @sections.delete section.title - end - - other_sections.each do |group, sections| - if my_sections.include? group - my_sections[group].each do |my_section| - other_section = cm.sections_hash[group] - - my_comments = my_section.comments - other_comments = other_section.comments - - other_files = other_section.in_files - - merge_collections my_comments, other_comments, other_files do |add, comment| - if add then - my_section.add_comment comment - else - my_section.remove_comment comment - end - end - end - else - sections.each do |section| - add_section group, section.comments - end - end - end - end - - ## - # Does this object represent a module? - - def module? - false - end - - ## - # Allows overriding the initial name. - # - # Used for modules and classes that are constant aliases. - - def name= new_name - @name = new_name - end - - ## - # Parses +comment_location+ into an RDoc::Markup::Document composed of - # multiple RDoc::Markup::Documents with their file set. - - def parse comment_location - case comment_location - when String then - super - when Array then - docs = comment_location.map do |comment, location| - doc = super comment - doc.file = location - doc - end - - RDoc::Markup::Document.new(*docs) - when RDoc::Comment then - doc = super comment_location.text, comment_location.format - doc.file = comment_location.location - doc - when RDoc::Markup::Document then - return comment_location - else - raise ArgumentError, "unknown comment class #{comment_location.class}" - end - end - - ## - # Path to this class or module for use with HTML generator output. - - def path - http_url @store.rdoc.generator.class_dir - end - - ## - # Name to use to generate the url: - # modules and classes that are aliases for another - # module or class return the name of the latter. - - def name_for_path - is_alias_for ? is_alias_for.full_name : full_name - end - - ## - # Returns the classes and modules that are not constants - # aliasing another class or module. For use by formatters - # only (caches its result). - - def non_aliases - @non_aliases ||= classes_and_modules.reject { |cm| cm.is_alias_for } - end - - ## - # Updates the child modules or classes of class/module +parent+ by - # deleting the ones that have been removed from the documentation. - # - # +parent_hash+ is either parent.modules_hash or - # parent.classes_hash and +all_hash+ is ::all_modules_hash or - # ::all_classes_hash. - - def remove_nodoc_children - prefix = self.full_name + '::' - - modules_hash.each_key do |name| - full_name = prefix + name - modules_hash.delete name unless @store.modules_hash[full_name] - end - - classes_hash.each_key do |name| - full_name = prefix + name - classes_hash.delete name unless @store.classes_hash[full_name] - end - end - - def remove_things my_things, other_files # :nodoc: - my_things.delete_if do |file, things| - next false unless other_files.include? file - - things.each do |thing| - yield false, thing - end - - true - end - end - - ## - # Search record used by RDoc::Generator::JsonIndex - - def search_record - [ - name, - full_name, - full_name, - '', - path, - '', - snippet(@comment_location), - ] - end - - ## - # Sets the store for this class or module and its contained code objects. - - def store= store - super - - @attributes .each do |attr| attr.store = store end - @constants .each do |const| const.store = store end - @includes .each do |incl| incl.store = store end - @extends .each do |ext| ext.store = store end - @method_list.each do |meth| meth.store = store end - end - - ## - # Get the superclass of this class. Attempts to retrieve the superclass - # object, returns the name if it is not known. - - def superclass - @store.find_class_named(@superclass) || @superclass - end - - ## - # Set the superclass of this class to +superclass+ - # - # where +superclass+ is one of: - # - # - +nil+ - # - a String containing the full name of the superclass - # - the RDoc::ClassModule representing the superclass - - def superclass=(superclass) - raise NoMethodError, "#{full_name} is a module" if module? - case superclass - when RDoc::ClassModule - @superclass = superclass.full_name - when nil, String - @superclass = superclass - else - raise TypeError, "superclass must be a String or RDoc::ClassModule, not #{superclass.class}" - end - end - - ## - # Get all super classes of this class in an array. The last element might be - # a string if the name is unknown. - - def super_classes - result = [] - parent = self - while parent = parent.superclass - result << parent - return result if parent.is_a?(String) - end - result - end - - def to_s # :nodoc: - if is_alias_for then - "#{self.class.name} #{self.full_name} -> #{is_alias_for}" - else - super - end - end - - ## - # 'module' or 'class' - - def type - module? ? 'module' : 'class' - end - - ## - # Updates the child modules & classes by replacing the ones that are - # aliases through a constant. - # - # The aliased module/class is replaced in the children and in - # RDoc::Store#modules_hash or RDoc::Store#classes_hash - # by a copy that has RDoc::ClassModule#is_alias_for set to - # the aliased module/class, and this copy is added to #aliases - # of the aliased module/class. - # - # Formatters can use the #non_aliases method to retrieve children that - # are not aliases, for instance to list the namespace content, since - # the aliased modules are included in the constants of the class/module, - # that are listed separately. - - def update_aliases - constants.each do |const| - next unless cm = const.is_alias_for - cm_alias = cm.dup - cm_alias.name = const.name - - # Don't move top-level aliases under Object, they look ugly there - unless RDoc::TopLevel === cm_alias.parent then - cm_alias.parent = self - cm_alias.full_name = nil # force update for new parent - end - - cm_alias.aliases.clear - cm_alias.is_alias_for = cm - - if cm.module? then - @store.modules_hash[cm_alias.full_name] = cm_alias - modules_hash[const.name] = cm_alias - else - @store.classes_hash[cm_alias.full_name] = cm_alias - classes_hash[const.name] = cm_alias - end - - cm.aliases << cm_alias - end - end - - ## - # Deletes from #includes those whose module has been removed from the - # documentation. - #-- - # FIXME: includes are not reliably removed, see _possible_bug test case - - def update_includes - includes.reject! do |include| - mod = include.module - !(String === mod) && @store.modules_hash[mod.full_name].nil? - end - - includes.uniq! - end - - ## - # Deletes from #extends those whose module has been removed from the - # documentation. - #-- - # FIXME: like update_includes, extends are not reliably removed - - def update_extends - extends.reject! do |ext| - mod = ext.module - - !(String === mod) && @store.modules_hash[mod.full_name].nil? - end - - extends.uniq! - end - - def embed_mixins - return unless options.embed_mixins - - includes.each do |include| - next if String === include.module - include.module.method_list.each do |code_object| - add_method(prepare_to_embed(code_object)) - end - include.module.constants.each do |code_object| - add_constant(prepare_to_embed(code_object)) - end - include.module.attributes.each do |code_object| - add_attribute(prepare_to_embed(code_object)) - end - end - - extends.each do |ext| - next if String === ext.module - ext.module.method_list.each do |code_object| - add_method(prepare_to_embed(code_object, true)) - end - ext.module.attributes.each do |code_object| - add_attribute(prepare_to_embed(code_object, true)) - end - end - end - - private - - def prepare_to_embed(code_object, singleton=false) - code_object = code_object.dup - code_object.mixin_from = code_object.parent - code_object.singleton = true if singleton - set_current_section(code_object.section.title, code_object.section.comment) - # add_method and add_attribute will reassign self's visibility back to the method/attribute - # so we need to sync self's visibility with the object's to properly retain that information - self.visibility = code_object.visibility - code_object - end -end diff --git a/lib/rdoc/code_object/constant.rb b/lib/rdoc/code_object/constant.rb deleted file mode 100644 index 12b8be775c..0000000000 --- a/lib/rdoc/code_object/constant.rb +++ /dev/null @@ -1,186 +0,0 @@ -# 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 - - ## - # Creates a new constant with +name+, +value+ and +comment+ - - def initialize(name, value, comment) - super() - - @name = name - @value = value - - @is_alias_for = 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 - - 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 - - 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, 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 - - 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 diff --git a/lib/rdoc/code_object/context.rb b/lib/rdoc/code_object/context.rb deleted file mode 100644 index c688d562c3..0000000000 --- a/lib/rdoc/code_object/context.rb +++ /dev/null @@ -1,1264 +0,0 @@ -# frozen_string_literal: true -## -# A Context is something that can hold modules, classes, methods, attributes, -# aliases, requires, and includes. Classes, modules, and files are all -# Contexts. - -class RDoc::Context < RDoc::CodeObject - - include Comparable - - ## - # Types of methods - - TYPES = %w[class instance] - - ## - # If a context has these titles it will be sorted in this order. - - TOMDOC_TITLES = [nil, 'Public', 'Internal', 'Deprecated'] # :nodoc: - TOMDOC_TITLES_SORT = TOMDOC_TITLES.sort_by { |title| title.to_s } # :nodoc: - - ## - # Class/module aliases - - attr_reader :aliases - - ## - # All attr* methods - - attr_reader :attributes - - ## - # Block params to be used in the next MethodAttr parsed under this context - - attr_accessor :block_params - - ## - # Constants defined - - attr_reader :constants - - ## - # Sets the current documentation section of documentation - - attr_writer :current_section - - ## - # Files this context is found in - - attr_reader :in_files - - ## - # Modules this context includes - - attr_reader :includes - - ## - # Modules this context is extended with - - attr_reader :extends - - ## - # Methods defined in this context - - attr_reader :method_list - - ## - # Name of this class excluding namespace. See also full_name - - attr_reader :name - - ## - # Files this context requires - - attr_reader :requires - - ## - # Use this section for the next method, attribute or constant added. - - attr_accessor :temporary_section - - ## - # Hash old_name => [aliases], for aliases - # that haven't (yet) been resolved to a method/attribute. - # (Not to be confused with the aliases of the context.) - - attr_accessor :unmatched_alias_lists - - ## - # Aliases that could not be resolved. - - attr_reader :external_aliases - - ## - # Current visibility of this context - - attr_accessor :visibility - - ## - # Current visibility of this line - - attr_writer :current_line_visibility - - ## - # Hash of registered methods. Attributes are also registered here, - # twice if they are RW. - - attr_reader :methods_hash - - ## - # Params to be used in the next MethodAttr parsed under this context - - attr_accessor :params - - ## - # Hash of registered constants. - - attr_reader :constants_hash - - ## - # Creates an unnamed empty context with public current visibility - - def initialize - super - - @in_files = [] - - @name ||= "unknown" - @parent = nil - @visibility = :public - - @current_section = Section.new self, nil, nil - @sections = { nil => @current_section } - @temporary_section = nil - - @classes = {} - @modules = {} - - initialize_methods_etc - end - - ## - # Sets the defaults for methods and so-forth - - def initialize_methods_etc - @method_list = [] - @attributes = [] - @aliases = [] - @requires = [] - @includes = [] - @extends = [] - @constants = [] - @external_aliases = [] - @current_line_visibility = nil - - # This Hash maps a method name to a list of unmatched aliases (aliases of - # a method not yet encountered). - @unmatched_alias_lists = {} - - @methods_hash = {} - @constants_hash = {} - - @params = nil - - @store ||= nil - end - - ## - # Contexts are sorted by full_name - - def <=>(other) - return nil unless RDoc::CodeObject === other - - full_name <=> other.full_name - end - - ## - # Adds an item of type +klass+ with the given +name+ and +comment+ to the - # context. - # - # Currently only RDoc::Extend and RDoc::Include are supported. - - def add klass, name, comment - if RDoc::Extend == klass then - ext = RDoc::Extend.new name, comment - add_extend ext - elsif RDoc::Include == klass then - incl = RDoc::Include.new name, comment - add_include incl - else - raise NotImplementedError, "adding a #{klass} is not implemented" - end - end - - ## - # Adds +an_alias+ that is automatically resolved - - def add_alias an_alias - return an_alias unless @document_self - - method_attr = find_method(an_alias.old_name, an_alias.singleton) || - find_attribute(an_alias.old_name, an_alias.singleton) - - if method_attr then - method_attr.add_alias an_alias, self - else - add_to @external_aliases, an_alias - unmatched_alias_list = - @unmatched_alias_lists[an_alias.pretty_old_name] ||= [] - unmatched_alias_list.push an_alias - end - - an_alias - end - - ## - # Adds +attribute+ if not already there. If it is (as method(s) or attribute), - # updates the comment if it was empty. - # - # The attribute is registered only if it defines a new method. - # For instance, attr_reader :foo will not be registered - # if method +foo+ exists, but attr_accessor :foo will be registered - # if method +foo+ exists, but foo= does not. - - def add_attribute attribute - return attribute unless @document_self - - # mainly to check for redefinition of an attribute as a method - # TODO find a policy for 'attr_reader :foo' + 'def foo=()' - register = false - - key = nil - - if attribute.rw.index 'R' then - key = attribute.pretty_name - known = @methods_hash[key] - - if known then - known.comment = attribute.comment if known.comment.empty? - elsif registered = @methods_hash[attribute.pretty_name + '='] and - RDoc::Attr === registered then - registered.rw = 'RW' - else - @methods_hash[key] = attribute - register = true - end - end - - if attribute.rw.index 'W' then - key = attribute.pretty_name + '=' - known = @methods_hash[key] - - if known then - known.comment = attribute.comment if known.comment.empty? - elsif registered = @methods_hash[attribute.pretty_name] and - RDoc::Attr === registered then - registered.rw = 'RW' - else - @methods_hash[key] = attribute - register = true - end - end - - if register then - attribute.visibility = @visibility - add_to @attributes, attribute - resolve_aliases attribute - end - - attribute - end - - ## - # Adds a class named +given_name+ with +superclass+. - # - # Both +given_name+ and +superclass+ may contain '::', and are - # interpreted relative to the +self+ context. This allows handling correctly - # examples like these: - # class RDoc::Gauntlet < Gauntlet - # module Mod - # class Object # implies < ::Object - # class SubObject < Object # this is _not_ ::Object - # - # Given class Container::Item RDoc assumes +Container+ is a module - # unless it later sees class Container. +add_class+ automatically - # upgrades +given_name+ to a class in this case. - - def add_class class_type, given_name, superclass = '::Object' - # superclass +nil+ is passed by the C parser in the following cases: - # - registering Object in 1.8 (correct) - # - registering BasicObject in 1.9 (correct) - # - registering RubyVM in 1.9 in iseq.c (incorrect: < Object in vm.c) - # - # If we later find a superclass for a registered class with a nil - # superclass, we must honor it. - - # find the name & enclosing context - if given_name =~ /^:+(\w+)$/ then - full_name = $1 - enclosing = top_level - name = full_name.split(/:+/).last - else - full_name = child_name given_name - - if full_name =~ /^(.+)::(\w+)$/ then - name = $2 - ename = $1 - enclosing = @store.classes_hash[ename] || @store.modules_hash[ename] - # HACK: crashes in actionpack/lib/action_view/helpers/form_helper.rb (metaprogramming) - unless enclosing then - # try the given name at top level (will work for the above example) - enclosing = @store.classes_hash[given_name] || - @store.modules_hash[given_name] - return enclosing if enclosing - # not found: create the parent(s) - names = ename.split('::') - enclosing = self - names.each do |n| - enclosing = enclosing.classes_hash[n] || - enclosing.modules_hash[n] || - enclosing.add_module(RDoc::NormalModule, n) - end - end - else - name = full_name - enclosing = self - end - end - - # fix up superclass - if full_name == 'BasicObject' then - superclass = nil - elsif full_name == 'Object' then - superclass = '::BasicObject' - end - - # find the superclass full name - if superclass then - if superclass =~ /^:+/ then - superclass = $' #' - else - if superclass =~ /^(\w+):+(.+)$/ then - suffix = $2 - mod = find_module_named($1) - superclass = mod.full_name + '::' + suffix if mod - else - mod = find_module_named(superclass) - superclass = mod.full_name if mod - end - end - - # did we believe it was a module? - mod = @store.modules_hash.delete superclass - - upgrade_to_class mod, RDoc::NormalClass, mod.parent if mod - - # e.g., Object < Object - superclass = nil if superclass == full_name - end - - klass = @store.classes_hash[full_name] - - if klass then - # if TopLevel, it may not be registered in the classes: - enclosing.classes_hash[name] = klass - - # update the superclass if needed - if superclass then - existing = klass.superclass - existing = existing.full_name unless existing.is_a?(String) if existing - if existing.nil? || - (existing == 'Object' && superclass != 'Object') then - klass.superclass = superclass - end - end - else - # this is a new class - mod = @store.modules_hash.delete full_name - - if mod then - klass = upgrade_to_class mod, RDoc::NormalClass, enclosing - - klass.superclass = superclass unless superclass.nil? - else - klass = class_type.new name, superclass - - enclosing.add_class_or_module(klass, enclosing.classes_hash, - @store.classes_hash) - end - end - - klass.parent = self - - klass - end - - ## - # Adds the class or module +mod+ to the modules or - # classes Hash +self_hash+, and to +all_hash+ (either - # TopLevel::modules_hash or TopLevel::classes_hash), - # unless #done_documenting is +true+. Sets the #parent of +mod+ - # to +self+, and its #section to #current_section. Returns +mod+. - - def add_class_or_module mod, self_hash, all_hash - mod.section = current_section # TODO declaring context? something is - # wrong here... - mod.parent = self - mod.full_name = nil - mod.store = @store - - unless @done_documenting then - self_hash[mod.name] = mod - # this must be done AFTER adding mod to its parent, so that the full - # name is correct: - all_hash[mod.full_name] = mod - if @store.unmatched_constant_alias[mod.full_name] then - to, file = @store.unmatched_constant_alias[mod.full_name] - add_module_alias mod, mod.name, to, file - end - end - - mod - end - - ## - # Adds +constant+ if not already there. If it is, updates the comment, - # value and/or is_alias_for of the known constant if they were empty/nil. - - def add_constant constant - return constant unless @document_self - - # HACK: avoid duplicate 'PI' & 'E' in math.c (1.8.7 source code) - # (this is a #ifdef: should be handled by the C parser) - known = @constants_hash[constant.name] - - if known then - known.comment = constant.comment if known.comment.empty? - - known.value = constant.value if - known.value.nil? or known.value.strip.empty? - - known.is_alias_for ||= constant.is_alias_for - else - @constants_hash[constant.name] = constant - add_to @constants, constant - end - - constant - end - - ## - # Adds included module +include+ which should be an RDoc::Include - - def add_include include - add_to @includes, include - - include - end - - ## - # Adds extension module +ext+ which should be an RDoc::Extend - - def add_extend ext - add_to @extends, ext - - ext - end - - ## - # Adds +method+ if not already there. If it is (as method or attribute), - # updates the comment if it was empty. - - def add_method method - return method unless @document_self - - # HACK: avoid duplicate 'new' in io.c & struct.c (1.8.7 source code) - key = method.pretty_name - known = @methods_hash[key] - - if known then - if @store then # otherwise we are loading - known.comment = method.comment if known.comment.empty? - previously = ", previously in #{known.file}" unless - method.file == known.file - @store.rdoc.options.warn \ - "Duplicate method #{known.full_name} in #{method.file}#{previously}" - end - else - @methods_hash[key] = method - if @current_line_visibility - method.visibility, @current_line_visibility = @current_line_visibility, nil - else - method.visibility = @visibility - end - add_to @method_list, method - resolve_aliases method - end - - method - end - - ## - # Adds a module named +name+. If RDoc already knows +name+ is a class then - # that class is returned instead. See also #add_class. - - def add_module(class_type, name) - mod = @classes[name] || @modules[name] - return mod if mod - - full_name = child_name name - mod = @store.modules_hash[full_name] || class_type.new(name) - - add_class_or_module mod, @modules, @store.modules_hash - end - - ## - # Adds a module by +RDoc::NormalModule+ instance. See also #add_module. - - def add_module_by_normal_module(mod) - add_class_or_module mod, @modules, @store.modules_hash - end - - ## - # Adds an alias from +from+ (a class or module) to +name+ which was defined - # in +file+. - - def add_module_alias from, from_name, to, file - return from if @done_documenting - - to_full_name = child_name to.name - - # if we already know this name, don't register an alias: - # see the metaprogramming in lib/active_support/basic_object.rb, - # where we already know BasicObject is a class when we find - # BasicObject = BlankSlate - return from if @store.find_class_or_module to_full_name - - unless from - @store.unmatched_constant_alias[child_name(from_name)] = [to, file] - return to - end - - new_to = from.dup - new_to.name = to.name - new_to.full_name = nil - - if new_to.module? then - @store.modules_hash[to_full_name] = new_to - @modules[to.name] = new_to - else - @store.classes_hash[to_full_name] = new_to - @classes[to.name] = new_to - end - - # Registers a constant for this alias. The constant value and comment - # will be updated later, when the Ruby parser adds the constant - const = RDoc::Constant.new to.name, nil, new_to.comment - const.record_location file - const.is_alias_for = from - add_constant const - - new_to - end - - ## - # Adds +require+ to this context's top level - - def add_require(require) - return require unless @document_self - - if RDoc::TopLevel === self then - add_to @requires, require - else - parent.add_require require - end - end - - ## - # Returns a section with +title+, creating it if it doesn't already exist. - # +comment+ will be appended to the section's comment. - # - # A section with a +title+ of +nil+ will return the default section. - # - # See also RDoc::Context::Section - - def add_section title, comment = nil - if section = @sections[title] then - section.add_comment comment if comment - else - section = Section.new self, title, comment - @sections[title] = section - end - - section - end - - ## - # Adds +thing+ to the collection +array+ - - def add_to array, thing - array << thing if @document_self - - thing.parent = self - thing.store = @store if @store - thing.section = current_section - end - - ## - # Is there any content? - # - # This means any of: comment, aliases, methods, attributes, external - # aliases, require, constant. - # - # Includes and extends are also checked unless includes == false. - - def any_content(includes = true) - @any_content ||= !( - @comment.empty? && - @method_list.empty? && - @attributes.empty? && - @aliases.empty? && - @external_aliases.empty? && - @requires.empty? && - @constants.empty? - ) - @any_content || (includes && !(@includes + @extends).empty? ) - end - - ## - # Creates the full name for a child with +name+ - - def child_name name - if name =~ /^:+/ - $' #' - elsif RDoc::TopLevel === self then - name - else - "#{self.full_name}::#{name}" - end - end - - ## - # Class attributes - - def class_attributes - @class_attributes ||= attributes.select { |a| a.singleton } - end - - ## - # Class methods - - def class_method_list - @class_method_list ||= method_list.select { |a| a.singleton } - end - - ## - # Array of classes in this context - - def classes - @classes.values - end - - ## - # All classes and modules in this namespace - - def classes_and_modules - classes + modules - end - - ## - # Hash of classes keyed by class name - - def classes_hash - @classes - end - - ## - # The current documentation section that new items will be added to. If - # temporary_section is available it will be used. - - def current_section - if section = @temporary_section then - @temporary_section = nil - else - section = @current_section - end - - section - end - - ## - # Is part of this thing was defined in +file+? - - def defined_in?(file) - @in_files.include?(file) - end - - def display(method_attr) # :nodoc: - if method_attr.is_a? RDoc::Attr - "#{method_attr.definition} #{method_attr.pretty_name}" - else - "method #{method_attr.pretty_name}" - end - end - - ## - # Iterator for ancestors for duck-typing. Does nothing. See - # RDoc::ClassModule#each_ancestor. - # - # This method exists to make it easy to work with Context subclasses that - # aren't part of RDoc. - - def each_ancestor(&_) # :nodoc: - end - - ## - # Iterator for attributes - - def each_attribute # :yields: attribute - @attributes.each { |a| yield a } - end - - ## - # Iterator for classes and modules - - def each_classmodule(&block) # :yields: module - classes_and_modules.sort.each(&block) - end - - ## - # Iterator for constants - - def each_constant # :yields: constant - @constants.each {|c| yield c} - end - - ## - # Iterator for included modules - - def each_include # :yields: include - @includes.each do |i| yield i end - end - - ## - # Iterator for extension modules - - def each_extend # :yields: extend - @extends.each do |e| yield e end - end - - ## - # Iterator for methods - - def each_method # :yields: method - return enum_for __method__ unless block_given? - - @method_list.sort.each { |m| yield m } - end - - ## - # Iterator for each section's contents sorted by title. The +section+, the - # section's +constants+ and the sections +attributes+ are yielded. The - # +constants+ and +attributes+ collections are sorted. - # - # To retrieve methods in a section use #methods_by_type with the optional - # +section+ parameter. - # - # NOTE: Do not edit collections yielded by this method - - def each_section # :yields: section, constants, attributes - return enum_for __method__ unless block_given? - - constants = @constants.group_by do |constant| constant.section end - attributes = @attributes.group_by do |attribute| attribute.section end - - constants.default = [] - attributes.default = [] - - sort_sections.each do |section| - yield section, constants[section].select(&:display?).sort, attributes[section].select(&:display?).sort - end - end - - ## - # Finds an attribute +name+ with singleton value +singleton+. - - def find_attribute(name, singleton) - name = $1 if name =~ /^(.*)=$/ - @attributes.find { |a| a.name == name && a.singleton == singleton } - end - - ## - # Finds an attribute with +name+ in this context - - def find_attribute_named(name) - case name - when /\A#/ then - find_attribute name[1..-1], false - when /\A::/ then - find_attribute name[2..-1], true - else - @attributes.find { |a| a.name == name } - end - end - - ## - # Finds a class method with +name+ in this context - - def find_class_method_named(name) - @method_list.find { |meth| meth.singleton && meth.name == name } - end - - ## - # Finds a constant with +name+ in this context - - def find_constant_named(name) - @constants.find do |m| - m.name == name || m.full_name == name - end - end - - ## - # Find a module at a higher scope - - def find_enclosing_module_named(name) - parent && parent.find_module_named(name) - end - - ## - # Finds an external alias +name+ with singleton value +singleton+. - - def find_external_alias(name, singleton) - @external_aliases.find { |m| m.name == name && m.singleton == singleton } - end - - ## - # Finds an external alias with +name+ in this context - - def find_external_alias_named(name) - case name - when /\A#/ then - find_external_alias name[1..-1], false - when /\A::/ then - find_external_alias name[2..-1], true - else - @external_aliases.find { |a| a.name == name } - end - end - - ## - # Finds a file with +name+ in this context - - def find_file_named name - @store.find_file_named name - end - - ## - # Finds an instance method with +name+ in this context - - def find_instance_method_named(name) - @method_list.find { |meth| !meth.singleton && meth.name == name } - end - - ## - # Finds a method, constant, attribute, external alias, module or file - # named +symbol+ in this context. - - def find_local_symbol(symbol) - find_method_named(symbol) or - find_constant_named(symbol) or - find_attribute_named(symbol) or - find_external_alias_named(symbol) or - find_module_named(symbol) or - find_file_named(symbol) - end - - ## - # Finds a method named +name+ with singleton value +singleton+. - - def find_method(name, singleton) - @method_list.find { |m| - if m.singleton - m.name == name && m.singleton == singleton - else - m.name == name && !m.singleton && !singleton - end - } - end - - ## - # Finds a instance or module method with +name+ in this context - - def find_method_named(name) - case name - when /\A#/ then - find_method name[1..-1], false - when /\A::/ then - find_method name[2..-1], true - else - @method_list.find { |meth| meth.name == name } - end - end - - ## - # Find a module with +name+ using ruby's scoping rules - - def find_module_named(name) - res = @modules[name] || @classes[name] - return res if res - return self if self.name == name - find_enclosing_module_named name - end - - ## - # Look up +symbol+, first as a module, then as a local symbol. - - def find_symbol(symbol) - find_symbol_module(symbol) || find_local_symbol(symbol) - end - - ## - # Look up a module named +symbol+. - - def find_symbol_module(symbol) - result = nil - - # look for a class or module 'symbol' - case symbol - when /^::/ then - result = @store.find_class_or_module symbol - when /^(\w+):+(.+)$/ - suffix = $2 - top = $1 - searched = self - while searched do - mod = searched.find_module_named(top) - break unless mod - result = @store.find_class_or_module "#{mod.full_name}::#{suffix}" - break if result || searched.is_a?(RDoc::TopLevel) - searched = searched.parent - end - else - searched = self - while searched do - result = searched.find_module_named(symbol) - break if result || searched.is_a?(RDoc::TopLevel) - searched = searched.parent - end - end - - result - end - - ## - # The full name for this context. This method is overridden by subclasses. - - def full_name - '(unknown)' - end - - ## - # Does this context and its methods and constants all have documentation? - # - # (Yes, fully documented doesn't mean everything.) - - def fully_documented? - documented? and - attributes.all? { |a| a.documented? } and - method_list.all? { |m| m.documented? } and - constants.all? { |c| c.documented? } - end - - ## - # URL for this with a +prefix+ - - def http_url(prefix) - path = name_for_path - path = path.gsub(/<<\s*(\w*)/, 'from-\1') if path =~ /<'class' or - # 'instance') and visibility (+:public+, +:protected+, +:private+). - # - # If +section+ is provided only methods in that RDoc::Context::Section will - # be returned. - - def methods_by_type section = nil - methods = {} - - TYPES.each do |type| - visibilities = {} - RDoc::VISIBILITIES.each do |vis| - visibilities[vis] = [] - end - - methods[type] = visibilities - end - - each_method do |method| - next if section and not method.section == section - methods[method.type][method.visibility] << method - end - - methods - end - - ## - # Yields AnyMethod and Attr entries matching the list of names in +methods+. - - def methods_matching(methods, singleton = false, &block) - (@method_list + @attributes).each do |m| - yield m if methods.include?(m.name) and m.singleton == singleton - end - - each_ancestor do |parent| - parent.methods_matching(methods, singleton, &block) - end - end - - ## - # Array of modules in this context - - def modules - @modules.values - end - - ## - # Hash of modules keyed by module name - - def modules_hash - @modules - end - - ## - # Name to use to generate the url. - # #full_name by default. - - def name_for_path - full_name - end - - ## - # Changes the visibility for new methods to +visibility+ - - def ongoing_visibility=(visibility) - @visibility = visibility - end - - ## - # Record +top_level+ as a file +self+ is in. - - def record_location(top_level) - @in_files << top_level unless @in_files.include?(top_level) - end - - ## - # Should we remove this context from the documentation? - # - # The answer is yes if: - # * #received_nodoc is +true+ - # * #any_content is +false+ (not counting includes) - # * All #includes are modules (not a string), and their module has - # #remove_from_documentation? == true - # * All classes and modules have #remove_from_documentation? == true - - def remove_from_documentation? - @remove_from_documentation ||= - @received_nodoc && - !any_content(false) && - @includes.all? { |i| !i.module.is_a?(String) && i.module.remove_from_documentation? } && - classes_and_modules.all? { |cm| cm.remove_from_documentation? } - end - - ## - # Removes methods and attributes with a visibility less than +min_visibility+. - #-- - # TODO mark the visibility of attributes in the template (if not public?) - - def remove_invisible min_visibility - return if [:private, :nodoc].include? min_visibility - remove_invisible_in @method_list, min_visibility - remove_invisible_in @attributes, min_visibility - remove_invisible_in @constants, min_visibility - end - - ## - # Only called when min_visibility == :public or :private - - def remove_invisible_in array, min_visibility # :nodoc: - if min_visibility == :public then - array.reject! { |e| - e.visibility != :public and not e.force_documentation - } - else - array.reject! { |e| - e.visibility == :private and not e.force_documentation - } - end - end - - ## - # Tries to resolve unmatched aliases when a method or attribute has just - # been added. - - def resolve_aliases added - # resolve any pending unmatched aliases - key = added.pretty_name - unmatched_alias_list = @unmatched_alias_lists[key] - return unless unmatched_alias_list - unmatched_alias_list.each do |unmatched_alias| - added.add_alias unmatched_alias, self - @external_aliases.delete unmatched_alias - end - @unmatched_alias_lists.delete key - end - - ## - # Returns RDoc::Context::Section objects referenced in this context for use - # in a table of contents. - - def section_contents - used_sections = {} - - each_method do |method| - next unless method.display? - - used_sections[method.section] = true - end - - # order found sections - sections = sort_sections.select do |section| - used_sections[section] - end - - # only the default section is used - return [] if - sections.length == 1 and not sections.first.title - - sections - end - - ## - # Sections in this context - - def sections - @sections.values - end - - def sections_hash # :nodoc: - @sections - end - - ## - # Sets the current section to a section with +title+. See also #add_section - - def set_current_section title, comment - @current_section = add_section title, comment - end - - ## - # Given an array +methods+ of method names, set the visibility of each to - # +visibility+ - - def set_visibility_for(methods, visibility, singleton = false) - methods_matching methods, singleton do |m| - m.visibility = visibility - end - end - - ## - # Given an array +names+ of constants, set the visibility of each constant to - # +visibility+ - - def set_constant_visibility_for(names, visibility) - names.each do |name| - constant = @constants_hash[name] or next - constant.visibility = visibility - end - end - - ## - # Sorts sections alphabetically (default) or in TomDoc fashion (none, - # Public, Internal, Deprecated) - - def sort_sections - titles = @sections.map { |title, _| title } - - if titles.length > 1 and - TOMDOC_TITLES_SORT == - (titles | TOMDOC_TITLES).sort_by { |title| title.to_s } then - @sections.values_at(*TOMDOC_TITLES).compact - else - @sections.sort_by { |title, _| - title.to_s - }.map { |_, section| - section - } - end - end - - def to_s # :nodoc: - "#{self.class.name} #{self.full_name}" - end - - ## - # Return the TopLevel that owns us - #-- - # FIXME we can be 'owned' by several TopLevel (see #record_location & - # #in_files) - - def top_level - return @top_level if defined? @top_level - @top_level = self - @top_level = @top_level.parent until RDoc::TopLevel === @top_level - @top_level - end - - ## - # Upgrades NormalModule +mod+ in +enclosing+ to a +class_type+ - - def upgrade_to_class mod, class_type, enclosing - enclosing.modules_hash.delete mod.name - - klass = RDoc::ClassModule.from_module class_type, mod - klass.store = @store - - # if it was there, then we keep it even if done_documenting - @store.classes_hash[mod.full_name] = klass - enclosing.classes_hash[mod.name] = klass - - klass - end - - autoload :Section, "#{__dir__}/context/section" - -end diff --git a/lib/rdoc/code_object/context/section.rb b/lib/rdoc/code_object/context/section.rb deleted file mode 100644 index aecd4e0213..0000000000 --- a/lib/rdoc/code_object/context/section.rb +++ /dev/null @@ -1,233 +0,0 @@ -# frozen_string_literal: true -require 'cgi/util' - -## -# 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 comment - - attr_reader :comment - - ## - # Section comments - - attr_reader :comments - - ## - # Context this Section lives in - - attr_reader :parent - - ## - # Section title - - attr_reader :title - - ## - # Creates a new section with +title+ and +comment+ - - def initialize parent, title, comment - @parent = parent - @title = title ? title.strip : title - - @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 - comment = extract_comment comment - - return if comment.empty? - - case comment - when RDoc::Comment then - @comments << comment - when RDoc::Markup::Document then - @comments.concat comment.parts - when Array then - @comments.concat comment - else - raise TypeError, "unknown comment type: #{comment.inspect}" - end - end - - ## - # Anchor reference for linking to this section - - def aref - title = @title || '[untitled]' - - CGI.escape(title).gsub('%', '-').sub(/^-/, '') - end - - ## - # Extracts the comment for this section from the original comment block. - # If the first line contains :section:, strip it and use the rest. - # Otherwise remove lines up to the line containing :section:, and look - # for those lines again at the end and remove them. This lets us write - # - # # :section: The title - # # The body - - def extract_comment comment - case comment - when Array then - comment.map do |c| - extract_comment c - end - when nil - RDoc::Comment.new '' - when RDoc::Comment then - if comment.text =~ /^#[ \t]*:section:.*\n/ then - start = $` - rest = $' - - comment.text = if start.empty? then - rest - else - rest.sub(/#{start.chomp}\Z/, '') - end - end - - comment - when RDoc::Markup::Document then - comment - else - raise TypeError, "unknown comment #{comment.inspect}" - end - 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 - return [] if @comments.empty? - - case @comments - when Array then - @comments.map do |comment| - comment.file - end - when RDoc::Markup::Document then - @comment.parts.map do |document| - document.file - end - else - raise RDoc::Error, "BUG: unknown comment class #{@comments.class}" - end - 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, - parse, - ] - end - - ## - # De-serializes this Section. The section parent must be restored manually. - - def marshal_load array - @parent = nil - - @title = array[1] - @comments = array[2] - end - - ## - # Parses +comment_location+ into an RDoc::Markup::Document composed of - # multiple RDoc::Markup::Documents with their file set. - - def parse - case @comments - when String then - super - when Array then - docs = @comments.map do |comment, location| - doc = super comment - doc.file = location if location - doc - end - - RDoc::Markup::Document.new(*docs) - when RDoc::Comment then - doc = super @comments.text, comments.format - doc.file = @comments.location - doc - when RDoc::Markup::Document then - return @comments - else - raise ArgumentError, "unknown comment class #{comments.class}" - end - 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 - - ## - # Removes a comment from this section if it is from the same file as - # +comment+ - - def remove_comment comment - return if @comments.empty? - - case @comments - when Array then - @comments.delete_if do |my_comment| - my_comment.file == comment.file - end - when RDoc::Markup::Document then - @comments.parts.delete_if do |document| - document.file == comment.file.name - end - else - raise RDoc::Error, "BUG: unknown comment class #{@comments.class}" - end - end - -end diff --git a/lib/rdoc/code_object/extend.rb b/lib/rdoc/code_object/extend.rb deleted file mode 100644 index 7d57433de6..0000000000 --- a/lib/rdoc/code_object/extend.rb +++ /dev/null @@ -1,9 +0,0 @@ -# frozen_string_literal: true -## -# A Module extension to a class with \#extend -# -# RDoc::Extend.new 'Enumerable', 'comment ...' - -class RDoc::Extend < RDoc::Mixin - -end diff --git a/lib/rdoc/code_object/ghost_method.rb b/lib/rdoc/code_object/ghost_method.rb deleted file mode 100644 index 25f951e35e..0000000000 --- a/lib/rdoc/code_object/ghost_method.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true -## -# GhostMethod represents a method referenced only by a comment - -class RDoc::GhostMethod < RDoc::AnyMethod -end diff --git a/lib/rdoc/code_object/include.rb b/lib/rdoc/code_object/include.rb deleted file mode 100644 index c3e0d45e47..0000000000 --- a/lib/rdoc/code_object/include.rb +++ /dev/null @@ -1,9 +0,0 @@ -# frozen_string_literal: true -## -# A Module included in a class with \#include -# -# RDoc::Include.new 'Enumerable', 'comment ...' - -class RDoc::Include < RDoc::Mixin - -end diff --git a/lib/rdoc/code_object/meta_method.rb b/lib/rdoc/code_object/meta_method.rb deleted file mode 100644 index 8c95a0f78c..0000000000 --- a/lib/rdoc/code_object/meta_method.rb +++ /dev/null @@ -1,6 +0,0 @@ -# frozen_string_literal: true -## -# MetaMethod represents a meta-programmed method - -class RDoc::MetaMethod < RDoc::AnyMethod -end diff --git a/lib/rdoc/code_object/method_attr.rb b/lib/rdoc/code_object/method_attr.rb deleted file mode 100644 index 263780f7c7..0000000000 --- a/lib/rdoc/code_object/method_attr.rb +++ /dev/null @@ -1,430 +0,0 @@ -# frozen_string_literal: true -## -# Abstract class representing either a method or an attribute. - -class RDoc::MethodAttr < RDoc::CodeObject - - include Comparable - - ## - # Name of this method/attribute. - - attr_accessor :name - - ## - # public, protected, private - - attr_accessor :visibility - - ## - # Is this a singleton method/attribute? - - attr_accessor :singleton - - ## - # Source file token stream - - attr_reader :text - - ## - # Array of other names for this method/attribute - - attr_reader :aliases - - ## - # The method/attribute we're aliasing - - attr_accessor :is_alias_for - - #-- - # The attributes below are for AnyMethod only. - # They are left here for the time being to - # allow ri to operate. - # TODO modify ri to avoid calling these on attributes. - #++ - - ## - # Parameters yielded by the called block - - attr_reader :block_params - - ## - # Parameters for this method - - attr_accessor :params - - ## - # Different ways to call this method - - attr_accessor :call_seq - - ## - # The call_seq or the param_seq with method name, if there is no call_seq. - - attr_reader :arglists - - ## - # Pretty parameter list for this method - - attr_reader :param_seq - - - ## - # Creates a new MethodAttr from token stream +text+ and method or attribute - # name +name+. - # - # Usually this is called by super from a subclass. - - def initialize text, name - super() - - @text = text - @name = name - - @aliases = [] - @is_alias_for = nil - @parent_name = nil - @singleton = nil - @visibility = :public - @see = false - - @arglists = nil - @block_params = nil - @call_seq = nil - @param_seq = nil - @params = nil - end - - ## - # Resets cached data for the object so it can be rebuilt by accessor methods - - def initialize_copy other # :nodoc: - @full_name = nil - end - - def initialize_visibility # :nodoc: - super - @see = nil - end - - ## - # Order by #singleton then #name - - def <=>(other) - return unless other.respond_to?(:singleton) && - other.respond_to?(:name) - - [@singleton ? 0 : 1, name_ord_range, name] <=> - [other.singleton ? 0 : 1, other.name_ord_range, other.name] - end - - def == other # :nodoc: - equal?(other) or self.class == other.class and full_name == other.full_name - end - - ## - # A method/attribute is documented if any of the following is true: - # - it was marked with :nodoc:; - # - it has a comment; - # - it is an alias for a documented method; - # - it has a +#see+ method that is documented. - - def documented? - super or - (is_alias_for and is_alias_for.documented?) or - (see and see.documented?) - end - - ## - # A method/attribute to look at, - # in particular if this method/attribute has no documentation. - # - # It can be a method/attribute of the superclass or of an included module, - # including the Kernel module, which is always appended to the included - # modules. - # - # Returns +nil+ if there is no such method/attribute. - # The +#is_alias_for+ method/attribute, if any, is not included. - # - # Templates may generate a "see also ..." if this method/attribute - # has documentation, and "see ..." if it does not. - - def see - @see = find_see if @see == false - @see - 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 find_see # :nodoc: - return nil if singleton || is_alias_for - - # look for the method - other = find_method_or_attribute name - return other if other - - # if it is a setter, look for a getter - return nil unless name =~ /[a-z_]=$/i # avoid == or === - return find_method_or_attribute name[0..-2] - end - - def find_method_or_attribute name # :nodoc: - return nil unless parent.respond_to? :ancestors - - searched = parent.ancestors - kernel = @store.modules_hash['Kernel'] - - searched << kernel if kernel && - parent != kernel && !searched.include?(kernel) - - searched.each do |ancestor| - next if String === ancestor - next if parent == ancestor - - other = ancestor.find_method_named('#' + name) || - ancestor.find_attribute_named(name) - - return other if other - end - - nil - end - - ## - # Abstract method. Contexts in their building phase call this - # to register a new alias for this known method/attribute. - # - # - creates a new AnyMethod/Attribute named an_alias.new_name; - # - adds +self+ as an alias for the new method or attribute - # - adds the method or attribute to #aliases - # - adds the method or attribute to +context+. - - def add_alias(an_alias, context) - raise NotImplementedError - end - - ## - # HTML fragment reference for this method - - def aref - type = singleton ? 'c' : 'i' - # % characters are not allowed in html names => dash instead - "#{aref_prefix}-#{type}-#{html_name}" - end - - ## - # Prefix for +aref+, defined by subclasses. - - def aref_prefix - raise NotImplementedError - end - - ## - # Attempts to sanitize the content passed by the Ruby parser: - # remove outer parentheses, etc. - - def block_params=(value) - # 'yield.to_s' or 'assert yield, msg' - return @block_params = '' if value =~ /^[\.,]/ - - # remove trailing 'if/unless ...' - return @block_params = '' if value =~ /^(if|unless)\s/ - - value = $1.strip if value =~ /^(.+)\s(if|unless)\s/ - - # outer parentheses - value = $1 if value =~ /^\s*\((.*)\)\s*$/ - value = value.strip - - # proc/lambda - return @block_params = $1 if value =~ /^(proc|lambda)(\s*\{|\sdo)/ - - # surrounding +...+ or [...] - value = $1.strip if value =~ /^\+(.*)\+$/ - value = $1.strip if value =~ /^\[(.*)\]$/ - - return @block_params = '' if value.empty? - - # global variable - return @block_params = 'str' if value =~ /^\$[&0-9]$/ - - # wipe out array/hash indices - value.gsub!(/(\w)\[[^\[]+\]/, '\1') - - # remove @ from class/instance variables - value.gsub!(/@@?([a-z0-9_]+)/, '\1') - - # method calls => method name - value.gsub!(/([A-Z:a-z0-9_]+)\.([a-z0-9_]+)(\s*\(\s*[a-z0-9_.,\s]*\s*\)\s*)?/) do - case $2 - when 'to_s' then $1 - when 'const_get' then 'const' - when 'new' then - $1.split('::').last. # ClassName => class_name - gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2'). - gsub(/([a-z\d])([A-Z])/, '\1_\2'). - downcase - else - $2 - end - end - - # class prefixes - value.gsub!(/[A-Za-z0-9_:]+::/, '') - - # simple expressions - value = $1 if value =~ /^([a-z0-9_]+)\s*[-*+\/]/ - - @block_params = value.strip - end - - ## - # HTML id-friendly method/attribute name - - def html_name - require 'cgi/util' - - CGI.escape(@name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '') - end - - ## - # Full method/attribute name including namespace - - def full_name - @full_name ||= "#{parent_name}#{pretty_name}" - end - - def inspect # :nodoc: - alias_for = @is_alias_for ? " (alias for #{@is_alias_for.name})" : nil - visibility = self.visibility - visibility = "forced #{visibility}" if force_documentation - "#<%s:0x%x %s (%s)%s>" % [ - self.class, object_id, - full_name, - visibility, - alias_for, - ] - end - - ## - # '::' for a class method/attribute, '#' for an instance method. - - def name_prefix - @singleton ? '::' : '#' - end - - ## - # Name for output to HTML. For class methods the full name with a "." is - # used like +SomeClass.method_name+. For instance methods the class name is - # used if +context+ does not match the parent. - # - # This is to help prevent people from using :: to call class methods. - - def output_name context - return "#{name_prefix}#{@name}" if context == parent - - "#{parent_name}#{@singleton ? '.' : '#'}#{@name}" - end - - ## - # Method/attribute name with class/instance indicator - - def pretty_name - "#{name_prefix}#{@name}" - end - - ## - # Type of method/attribute (class or instance) - - def type - singleton ? 'class' : 'instance' - end - - ## - # Path to this method for use with HTML generator output. - - def path - "#{@parent.path}##{aref}" - end - - ## - # Name of our parent with special handling for un-marshaled methods - - def parent_name - @parent_name || super - end - - def pretty_print q # :nodoc: - alias_for = - if @is_alias_for.respond_to? :name then - "alias for #{@is_alias_for.name}" - elsif Array === @is_alias_for then - "alias for #{@is_alias_for.last}" - end - - q.group 2, "[#{self.class.name} #{full_name} #{visibility}", "]" do - if alias_for then - q.breakable - q.text alias_for - end - - if text then - q.breakable - q.text "text:" - q.breakable - q.pp @text - end - - unless comment.empty? then - q.breakable - q.text "comment:" - q.breakable - q.pp @comment - end - end - end - - ## - # Used by RDoc::Generator::JsonIndex to create a record for the search - # engine. - - def search_record - [ - @name, - full_name, - @name, - @parent.full_name, - path, - params, - snippet(@comment), - ] - end - - def to_s # :nodoc: - if @is_alias_for - "#{self.class.name}: #{full_name} -> #{is_alias_for}" - else - "#{self.class.name}: #{full_name}" - end - end - - def name_ord_range # :nodoc: - case name.ord - when 0..64 # anything below "A" - 1 - when 91..96 # the symbols between "Z" and "a" - 2 - when 123..126 # 7-bit symbols above "z": "{", "|", "}", "~" - 3 - else # everythig else can be sorted as normal - 4 - end - end -end diff --git a/lib/rdoc/code_object/mixin.rb b/lib/rdoc/code_object/mixin.rb deleted file mode 100644 index fa8faefc15..0000000000 --- a/lib/rdoc/code_object/mixin.rb +++ /dev/null @@ -1,120 +0,0 @@ -# frozen_string_literal: true -## -# A Mixin adds features from a module into another context. RDoc::Include and -# RDoc::Extend are both mixins. - -class RDoc::Mixin < RDoc::CodeObject - - ## - # Name of included module - - attr_accessor :name - - ## - # Creates a new Mixin for +name+ with +comment+ - - def initialize(name, comment) - super() - @name = name - self.comment = comment - @module = nil # cache for module if found - end - - ## - # Mixins are sorted by name - - def <=> other - return unless self.class === other - - name <=> other.name - end - - def == other # :nodoc: - self.class === other and @name == other.name - end - - alias eql? == # :nodoc: - - ## - # Full name based on #module - - def full_name - m = self.module - RDoc::ClassModule === m ? m.full_name : @name - end - - def hash # :nodoc: - [@name, self.module].hash - end - - def inspect # :nodoc: - "#<%s:0x%x %s.%s %s>" % [ - self.class, - object_id, - parent_name, self.class.name.downcase, @name, - ] - end - - ## - # Attempts to locate the included module object. Returns the name if not - # known. - # - # The scoping rules of Ruby to resolve the name of an included module are: - # - first look into the children of the current context; - # - if not found, look into the children of included modules, - # in reverse inclusion order; - # - if still not found, go up the hierarchy of names. - # - # This method has O(n!) behavior when the module calling - # include is referencing nonexistent modules. Avoid calling #module until - # after all the files are parsed. This behavior is due to ruby's constant - # lookup behavior. - # - # As of the beginning of October, 2011, no gem includes nonexistent modules. - - def module - return @module if @module - - # search the current context - return @name unless parent - full_name = parent.child_name(@name) - @module = @store.modules_hash[full_name] - return @module if @module - return @name if @name =~ /^::/ - - # search the includes before this one, in reverse order - searched = parent.includes.take_while { |i| i != self }.reverse - searched.each do |i| - inc = i.module - next if String === inc - full_name = inc.child_name(@name) - @module = @store.modules_hash[full_name] - return @module if @module - end - - # go up the hierarchy of names - up = parent.parent - while up - full_name = up.child_name(@name) - @module = @store.modules_hash[full_name] - return @module if @module - up = up.parent - end - - @name - 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: - "#{self.class.name.downcase} #@name in: #{parent}" - end - -end diff --git a/lib/rdoc/code_object/normal_class.rb b/lib/rdoc/code_object/normal_class.rb deleted file mode 100644 index aa340b5d15..0000000000 --- a/lib/rdoc/code_object/normal_class.rb +++ /dev/null @@ -1,92 +0,0 @@ -# frozen_string_literal: true -## -# A normal class, neither singleton nor anonymous - -class RDoc::NormalClass < RDoc::ClassModule - - ## - # The ancestors of this class including modules. Unlike Module#ancestors, - # this class is not included in the result. The result will contain both - # RDoc::ClassModules and Strings. - - def ancestors - if String === superclass then - super << superclass - elsif superclass then - ancestors = super - ancestors << superclass - ancestors.concat superclass.ancestors - else - super - end - end - - def aref_prefix # :nodoc: - 'class' - end - - ## - # The definition of this class, class MyClassName - - def definition - "class #{full_name}" - end - - def direct_ancestors - superclass ? super + [superclass] : super - end - - def inspect # :nodoc: - superclass = @superclass ? " < #{@superclass}" : nil - "<%s:0x%x class %s%s includes: %p extends: %p attributes: %p methods: %p aliases: %p>" % [ - self.class, object_id, - full_name, superclass, @includes, @extends, @attributes, @method_list, @aliases - ] - end - - def to_s # :nodoc: - display = "#{self.class.name} #{self.full_name}" - if superclass - display += ' < ' + (superclass.is_a?(String) ? superclass : superclass.full_name) - end - display += ' -> ' + is_alias_for.to_s if is_alias_for - display - end - - def pretty_print q # :nodoc: - superclass = @superclass ? " < #{@superclass}" : nil - - q.group 2, "[class #{full_name}#{superclass}", "]" do - q.breakable - q.text "includes:" - q.breakable - q.seplist @includes do |inc| q.pp inc end - - q.breakable - q.text "constants:" - q.breakable - q.seplist @constants do |const| q.pp const end - - q.breakable - 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 - -end diff --git a/lib/rdoc/code_object/normal_module.rb b/lib/rdoc/code_object/normal_module.rb deleted file mode 100644 index 498ec4dde2..0000000000 --- a/lib/rdoc/code_object/normal_module.rb +++ /dev/null @@ -1,73 +0,0 @@ -# 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, module MyModuleName - - 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 diff --git a/lib/rdoc/code_object/require.rb b/lib/rdoc/code_object/require.rb deleted file mode 100644 index 05e26b84b0..0000000000 --- a/lib/rdoc/code_object/require.rb +++ /dev/null @@ -1,51 +0,0 @@ -# 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 diff --git a/lib/rdoc/code_object/single_class.rb b/lib/rdoc/code_object/single_class.rb deleted file mode 100644 index dd16529648..0000000000 --- a/lib/rdoc/code_object/single_class.rb +++ /dev/null @@ -1,30 +0,0 @@ -# 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, class << MyClassName - - def definition - "class << #{full_name}" - end - - def pretty_print q # :nodoc: - q.group 2, "[class << #{full_name}", "]" do - next - end - end -end diff --git a/lib/rdoc/code_object/top_level.rb b/lib/rdoc/code_object/top_level.rb deleted file mode 100644 index b93e3802fc..0000000000 --- a/lib/rdoc/code_object/top_level.rb +++ /dev/null @@ -1,291 +0,0 @@ -# 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 = 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 diff --git a/lib/rdoc/code_objects.rb b/lib/rdoc/code_objects.rb deleted file mode 100644 index d5f2f920ad..0000000000 --- a/lib/rdoc/code_objects.rb +++ /dev/null @@ -1,5 +0,0 @@ -# frozen_string_literal: true -# This file was used to load all the RDoc::CodeObject subclasses at once. Now -# autoload handles this. - -require_relative '../rdoc' diff --git a/lib/rdoc/comment.rb b/lib/rdoc/comment.rb deleted file mode 100644 index 04ec226436..0000000000 --- a/lib/rdoc/comment.rb +++ /dev/null @@ -1,229 +0,0 @@ -# frozen_string_literal: true -## -# A comment holds the text comment for a RDoc::CodeObject and provides a -# unified way of cleaning it up and parsing it into an RDoc::Markup::Document. -# -# Each comment may have a different markup format set by #format=. By default -# 'rdoc' is used. The :markup: directive tells RDoc which format to use. -# -# See RDoc::MarkupReference@Directive+for+Specifying+RDoc+Source+Format. - - -class RDoc::Comment - - include RDoc::Text - - ## - # The format of this comment. Defaults to RDoc::Markup - - attr_reader :format - - ## - # The RDoc::TopLevel this comment was found in - - attr_accessor :location - - ## - # Line where this Comment was written - - attr_accessor :line - - ## - # For duck-typing when merging classes at load time - - alias file location # :nodoc: - - ## - # The text for this comment - - attr_reader :text - - ## - # Alias for text - - alias to_s text - - ## - # Overrides the content returned by #parse. Use when there is no #text - # source for this comment - - attr_writer :document - - ## - # Creates a new comment with +text+ that is found in the RDoc::TopLevel - # +location+. - - def initialize text = nil, location = nil, language = nil - @location = location - @text = text.nil? ? nil : text.dup - @language = language - - @document = nil - @format = 'rdoc' - @normalized = false - end - - ## - #-- - # TODO deep copy @document - - def initialize_copy copy # :nodoc: - @text = copy.text.dup - end - - def == other # :nodoc: - self.class === other and - other.text == @text and other.location == @location - end - - ## - # Look for a 'call-seq' in the comment to override the normal parameter - # handling. The :call-seq: is indented from the baseline. All lines of the - # same indentation level and prefix are consumed. - # - # For example, all of the following will be used as the :call-seq: - # - # # :call-seq: - # # ARGF.readlines(sep=$/) -> array - # # ARGF.readlines(limit) -> array - # # ARGF.readlines(sep, limit) -> array - # # - # # ARGF.to_a(sep=$/) -> array - # # ARGF.to_a(limit) -> array - # # ARGF.to_a(sep, limit) -> array - - def extract_call_seq method - # we must handle situations like the above followed by an unindented first - # comment. The difficulty is to make sure not to match lines starting - # with ARGF at the same indent, but that are after the first description - # paragraph. - if /^(? ((?!\n)\s)*+ (?# whitespaces except newline)) - :?call-seq: - (? \g(?\n|\z) (?# trailing spaces))? - (? - (\g(?!\w)\S.*\g)* - (?> - (? \g\w+ (?# ' # ARGF' in the example above)) - .*\g)? - (\g\S.*\g (?# other non-blank line))*+ - (\g+(\k.*\g (?# ARGF.to_a lines))++)*+ - ) - (?m:^\s*$|\z) - /x =~ @text - seq = $~[:seq] - - all_start, all_stop = $~.offset(0) - @text.slice! all_start...all_stop - - seq.gsub!(/^\s*/, '') - method.call_seq = seq - end - - method - end - - ## - # A comment is empty if its text String is empty. - - def empty? - @text.empty? - end - - ## - # HACK dubious - - def encode! encoding - @text = String.new @text, encoding: encoding - self - end - - ## - # Sets the format of this comment and resets any parsed document - - def format= format - @format = format - @document = nil - end - - def inspect # :nodoc: - location = @location ? @location.relative_name : '(unknown)' - - "#<%s:%x %s %p>" % [self.class, object_id, location, @text] - end - - ## - # Normalizes the text. See RDoc::Text#normalize_comment for details - - def normalize - return self unless @text - return self if @normalized # TODO eliminate duplicate normalization - - @text = normalize_comment @text - - @normalized = true - - self - end - - ## - # Was this text normalized? - - def normalized? # :nodoc: - @normalized - end - - ## - # Parses the comment into an RDoc::Markup::Document. The parsed document is - # cached until the text is changed. - - def parse - return @document if @document - - @document = super @text, @format - @document.file = @location - @document - end - - ## - # Removes private sections from this comment. Private sections are flush to - # the comment marker and start with -- and end with ++. - # For C-style comments, a private marker may not start at the opening of the - # comment. - # - # /* - # *-- - # * private - # *++ - # * public - # */ - - def remove_private - # Workaround for gsub encoding for Ruby 1.9.2 and earlier - empty = '' - empty = RDoc::Encoding.change_encoding empty, @text.encoding - - @text = @text.gsub(%r%^\s*([#*]?)--.*?^\s*(\1)\+\+\n?%m, empty) - @text = @text.sub(%r%^\s*[#*]?--.*%m, '') - end - - ## - # Replaces this comment's text with +text+ and resets the parsed document. - # - # An error is raised if the comment contains a document but no text. - - def text= text - raise RDoc::Error, 'replacing document-only comment is not allowed' if - @text.nil? and @document - - @document = nil - @text = text.nil? ? nil : text.dup - end - - ## - # Returns true if this comment is in TomDoc format. - - def tomdoc? - @format == 'tomdoc' - end - -end diff --git a/lib/rdoc/cross_reference.rb b/lib/rdoc/cross_reference.rb deleted file mode 100644 index 4e011219e8..0000000000 --- a/lib/rdoc/cross_reference.rb +++ /dev/null @@ -1,228 +0,0 @@ -# frozen_string_literal: true - -require_relative 'markup/attribute_manager' # for PROTECT_ATTR - -## -# RDoc::CrossReference is a reusable way to create cross references for names. - -class RDoc::CrossReference - - ## - # Regular expression to match class references - # - # 1. There can be a '\\' in front of text to suppress the cross-reference - # 2. There can be a '::' in front of class names to reference from the - # top-level namespace. - # 3. The method can be followed by parenthesis (not recommended) - - CLASS_REGEXP_STR = '\\\\?((?:\:{2})?[A-Z]\w*(?:\:\:\w+)*)' - - ## - # Regular expression to match a single method argument. - - METHOD_ARG_REGEXP_STR = '[\w.+*/=<>-]+' - - ## - # Regular expression to match method arguments. - - METHOD_ARGS_REGEXP_STR = /(?:\((?:#{METHOD_ARG_REGEXP_STR}(?:,\s*#{METHOD_ARG_REGEXP_STR})*)?\))?/.source - - ## - # Regular expression to match method references. - # - # See CLASS_REGEXP_STR - - METHOD_REGEXP_STR = /( - (?!\d)[\w#{RDoc::Markup::AttributeManager::PROTECT_ATTR}]+[!?=]?| - %|=(?:==?|~)|![=~]|\[\]=?|<(?:<|=>?)?|>[>=]?|[-+!]@?|\*\*?|[\/%\`|&^~] - )#{METHOD_ARGS_REGEXP_STR}/.source.delete("\n ").freeze - - ## - # Regular expressions matching text that should potentially have - # cross-reference links generated are passed to add_regexp_handling. Note - # that these expressions are meant to pick up text for which cross-references - # have been suppressed, since the suppression characters are removed by the - # code that is triggered. - - CROSSREF_REGEXP = /(?:^|[\s()]) - ( - (?: - # A::B::C.meth - #{CLASS_REGEXP_STR}(?:[.#]|::)#{METHOD_REGEXP_STR} - - # A::B::C - # The stuff after CLASS_REGEXP_STR is a - # nasty hack. CLASS_REGEXP_STR unfortunately matches - # words like dog and cat (these are legal "class" - # names in Fortran 95). When a word is flagged as a - # potential cross-reference, limitations in the markup - # engine suppress other processing, such as typesetting. - # This is particularly noticeable for contractions. - # In order that words like "can't" not - # be flagged as potential cross-references, only - # flag potential class cross-references if the character - # after the cross-reference is a space, sentence - # punctuation, tag start character, or attribute - # marker. - | #{CLASS_REGEXP_STR}(?=[@\s).?!,;<\000]|\z) - - # Stand-alone method (preceded by a #) - | \\?\##{METHOD_REGEXP_STR} - - # Stand-alone method (preceded by ::) - | ::#{METHOD_REGEXP_STR} - - # Things that look like filenames - # The key thing is that there must be at least - # one special character (period, slash, or - # underscore). - | (?:\.\.\/)*[-\/\w]+[_\/.][-\w\/.]+ - - # Things that have markup suppressed - # Don't process things like '\<' in \, though. - # TODO: including < is a hack, not very satisfying. - | \\[^\s<] - ) - - # labels for headings - (?:@[\w+%-]+(?:\.[\w|%-]+)?)? - )/x - - ## - # Version of CROSSREF_REGEXP used when --hyperlink-all is specified. - - ALL_CROSSREF_REGEXP = / - (?:^|[\s()]) - ( - (?: - # A::B::C.meth - #{CLASS_REGEXP_STR}(?:[.#]|::)#{METHOD_REGEXP_STR} - - # A::B::C - | #{CLASS_REGEXP_STR}(?=[@\s).?!,;<\000]|\z) - - # Stand-alone method - | \\?#{METHOD_REGEXP_STR} - - # Things that look like filenames - | (?:\.\.\/)*[-\/\w]+[_\/.][-\w\/.]+ - - # Things that have markup suppressed - | \\[^\s<] - ) - - # labels for headings - (?:@[\w+%-]+)? - )/x - - ## - # Hash of references that have been looked-up to their replacements - - attr_accessor :seen - - ## - # Allows cross-references to be created based on the given +context+ - # (RDoc::Context). - - def initialize context - @context = context - @store = context.store - - @seen = {} - end - - ## - # Returns a method reference to +name+. - - def resolve_method name - ref = nil - - if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then - type = $2 - if '.' == type # will find either #method or ::method - method = $3 - else - method = "#{type}#{$3}" - end - container = @context.find_symbol_module($1) - elsif /^([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then - type = $1 - if '.' == type - method = $2 - else - method = "#{type}#{$2}" - end - container = @context - else - type = nil - container = nil - end - - if container then - unless RDoc::TopLevel === container then - if '.' == type then - if 'new' == method then # AnyClassName.new will be class method - ref = container.find_local_symbol method - ref = container.find_ancestor_local_symbol method unless ref - else - ref = container.find_local_symbol "::#{method}" - ref = container.find_ancestor_local_symbol "::#{method}" unless ref - ref = container.find_local_symbol "##{method}" unless ref - ref = container.find_ancestor_local_symbol "##{method}" unless ref - end - else - ref = container.find_local_symbol method - ref = container.find_ancestor_local_symbol method unless ref - end - end - end - - ref - end - - ## - # Returns a reference to +name+. - # - # If the reference is found and +name+ is not documented +text+ will be - # returned. If +name+ is escaped +name+ is returned. If +name+ is not - # found +text+ is returned. - - def resolve name, text - return @seen[name] if @seen.include? name - - ref = case name - when /^\\(#{CLASS_REGEXP_STR})$/o then - @context.find_symbol $1 - else - @context.find_symbol name - end - - ref = resolve_method name unless ref - - # Try a page name - ref = @store.page name if not ref and name =~ /^[\w.]+$/ - - ref = nil if RDoc::Alias === ref # external alias, can't link to it - - out = if name == '\\' then - name - elsif name =~ /^\\/ then - # we remove the \ only in front of what we know: - # other backslashes are treated later, only outside of - ref ? $' : name - elsif ref then - if ref.display? then - ref - else - text - end - else - text - end - - @seen[name] = out - - out - end - -end diff --git a/lib/rdoc/encoding.rb b/lib/rdoc/encoding.rb deleted file mode 100644 index 67e190f782..0000000000 --- a/lib/rdoc/encoding.rb +++ /dev/null @@ -1,120 +0,0 @@ -# coding: US-ASCII -# frozen_string_literal: true - -## -# This class is a wrapper around File IO and Encoding that helps RDoc load -# files and convert them to the correct encoding. - -module RDoc::Encoding - - HEADER_REGEXP = /^ - (?: - \A\#!.*\n - | - ^\#\s+frozen[-_]string[-_]literal[=:].+\n - | - ^\#[^\n]+\b(?:en)?coding[=:]\s*(?[^\s;]+).*\n - | - <\?xml[^?]*encoding=(?["'])(?.*?)\k.*\n - )+ - /xi # :nodoc: - - ## - # Reads the contents of +filename+ and handles any encoding directives in - # the file. - # - # The content will be converted to the +encoding+. If the file cannot be - # converted a warning will be printed and nil will be returned. - # - # If +force_transcode+ is true the document will be transcoded and any - # unknown character in the target encoding will be replaced with '?' - - def self.read_file filename, encoding, force_transcode = false - content = File.open filename, "rb" do |f| f.read end - content.gsub!("\r\n", "\n") if RUBY_PLATFORM =~ /mswin|mingw/ - - utf8 = content.sub!(/\A\xef\xbb\xbf/, '') - - enc = RDoc::Encoding.detect_encoding content - content = RDoc::Encoding.change_encoding content, enc if enc - - begin - encoding ||= Encoding.default_external - orig_encoding = content.encoding - - if not orig_encoding.ascii_compatible? then - content = content.encode encoding - elsif utf8 then - content = RDoc::Encoding.change_encoding content, Encoding::UTF_8 - content = content.encode encoding - else - # assume the content is in our output encoding - content = RDoc::Encoding.change_encoding content, encoding - end - - unless content.valid_encoding? then - # revert and try to transcode - content = RDoc::Encoding.change_encoding content, orig_encoding - content = content.encode encoding - end - - unless content.valid_encoding? then - warn "unable to convert #{filename} to #{encoding}, skipping" - content = nil - end - rescue Encoding::InvalidByteSequenceError, - Encoding::UndefinedConversionError => e - if force_transcode then - content = RDoc::Encoding.change_encoding content, orig_encoding - content = content.encode(encoding, - :invalid => :replace, - :undef => :replace, - :replace => '?') - return content - else - warn "unable to convert #{e.message} for #{filename}, skipping" - return nil - end - end - - content - rescue ArgumentError => e - raise unless e.message =~ /unknown encoding name - (.*)/ - warn "unknown encoding name \"#{$1}\" for #{filename}, skipping" - nil - rescue Errno::EISDIR, Errno::ENOENT - nil - end - - ## - # Detects the encoding of +string+ based on the magic comment - - def self.detect_encoding string - result = HEADER_REGEXP.match string - name = result && result[:name] - - name ? Encoding.find(name) : nil - end - - ## - # Removes magic comments and shebang - - def self.remove_magic_comment string - string.sub HEADER_REGEXP do |s| - s.gsub(/[^\n]/, '') - end - end - - ## - # Changes encoding based on +encoding+ without converting and returns new - # string - - def self.change_encoding text, encoding - if text.kind_of? RDoc::Comment - text.encode! encoding - else - String.new text, encoding: encoding - end - end - -end diff --git a/lib/rdoc/erb_partial.rb b/lib/rdoc/erb_partial.rb deleted file mode 100644 index 043d763db1..0000000000 --- a/lib/rdoc/erb_partial.rb +++ /dev/null @@ -1,18 +0,0 @@ -# frozen_string_literal: true -## -# Allows an ERB template to be rendered in the context (binding) of an -# existing ERB template evaluation. - -class RDoc::ERBPartial < ERB - - ## - # Overrides +compiler+ startup to set the +eoutvar+ to an empty string only - # if it isn't already set. - - def set_eoutvar compiler, eoutvar = '_erbout' - super - - compiler.pre_cmd = ["#{eoutvar} ||= +''"] - end - -end diff --git a/lib/rdoc/erbio.rb b/lib/rdoc/erbio.rb deleted file mode 100644 index 0f98eaedee..0000000000 --- a/lib/rdoc/erbio.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true -require 'erb' - -## -# A subclass of ERB that writes directly to an IO. Credit to Aaron Patterson -# and Masatoshi SEKI. -# -# To use: -# -# erbio = RDoc::ERBIO.new '<%= "hello world" %>', nil, nil -# -# File.open 'hello.txt', 'w' do |io| -# erbio.result binding -# end -# -# Note that binding must enclose the io you wish to output on. - -class RDoc::ERBIO < ERB - - ## - # Defaults +eoutvar+ to 'io', otherwise is identical to ERB's initialize - - def initialize str, trim_mode: nil, eoutvar: 'io' - super(str, trim_mode: trim_mode, eoutvar: eoutvar) - end - - ## - # Instructs +compiler+ how to write to +io_variable+ - - def set_eoutvar compiler, io_variable - compiler.put_cmd = "#{io_variable}.write" - compiler.insert_cmd = "#{io_variable}.write" - compiler.pre_cmd = [] - compiler.post_cmd = [] - end - -end diff --git a/lib/rdoc/generator.rb b/lib/rdoc/generator.rb deleted file mode 100644 index a769cf8ac0..0000000000 --- a/lib/rdoc/generator.rb +++ /dev/null @@ -1,51 +0,0 @@ -# frozen_string_literal: true -## -# RDoc uses generators to turn parsed source code in the form of an -# RDoc::CodeObject tree into some form of output. RDoc comes with the HTML -# generator RDoc::Generator::Darkfish and an ri data generator -# RDoc::Generator::RI. -# -# == Registering a Generator -# -# Generators are registered by calling RDoc::RDoc.add_generator with the class -# of the generator: -# -# class My::Awesome::Generator -# RDoc::RDoc.add_generator self -# end -# -# == Adding Options to +rdoc+ -# -# Before option processing in +rdoc+, RDoc::Options will call ::setup_options -# on the generator class with an RDoc::Options instance. The generator can -# use RDoc::Options#option_parser to add command-line options to the +rdoc+ -# tool. See RDoc::Options@Custom+Options for an example and see OptionParser -# for details on how to add options. -# -# You can extend the RDoc::Options instance with additional accessors for your -# generator. -# -# == Generator Instantiation -# -# After parsing, RDoc::RDoc will instantiate a generator by calling -# #initialize with an RDoc::Store instance and an RDoc::Options instance. -# -# The RDoc::Store instance holds documentation for parsed source code. In -# RDoc 3 and earlier the RDoc::TopLevel class held this data. When upgrading -# a generator from RDoc 3 and earlier you should only need to replace -# RDoc::TopLevel with the store instance. -# -# RDoc will then call #generate on the generator instance. You can use the -# various methods on RDoc::Store and in the RDoc::CodeObject tree to create -# your desired output format. - -module RDoc::Generator - - autoload :Markup, "#{__dir__}/generator/markup" - - autoload :Darkfish, "#{__dir__}/generator/darkfish" - autoload :JsonIndex, "#{__dir__}/generator/json_index" - autoload :RI, "#{__dir__}/generator/ri" - autoload :POT, "#{__dir__}/generator/pot" - -end diff --git a/lib/rdoc/generator/darkfish.rb b/lib/rdoc/generator/darkfish.rb deleted file mode 100644 index 08f2b85e3b..0000000000 --- a/lib/rdoc/generator/darkfish.rb +++ /dev/null @@ -1,828 +0,0 @@ -# frozen_string_literal: true -# -*- mode: ruby; ruby-indent-level: 2; tab-width: 2 -*- - -require 'erb' -require 'fileutils' -require 'pathname' -require_relative 'markup' - -## -# Darkfish RDoc HTML Generator -# -# $Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $ -# -# == Author/s -# * Michael Granger (ged@FaerieMUD.org) -# -# == Contributors -# * Mahlon E. Smith (mahlon@martini.nu) -# * Eric Hodel (drbrain@segment7.net) -# -# == License -# -# Copyright (c) 2007, 2008, Michael Granger. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# * Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# -# * Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# * Neither the name of the author/s, nor the names of the project's -# contributors may be used to endorse or promote products derived from this -# software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# -# == Attributions -# -# Darkfish uses the {Silk Icons}[http://www.famfamfam.com/lab/icons/silk/] set -# by Mark James. - -class RDoc::Generator::Darkfish - - RDoc::RDoc.add_generator self - - include ERB::Util - - ## - # Stylesheets, fonts, etc. that are included in RDoc. - - BUILTIN_STYLE_ITEMS = # :nodoc: - %w[ - css/fonts.css - fonts/Lato-Light.ttf - fonts/Lato-LightItalic.ttf - fonts/Lato-Regular.ttf - fonts/Lato-RegularItalic.ttf - fonts/SourceCodePro-Bold.ttf - fonts/SourceCodePro-Regular.ttf - css/rdoc.css - ] - - ## - # Path to this file's parent directory. Used to find templates and other - # resources. - - GENERATOR_DIR = File.join 'rdoc', 'generator' - - ## - # Release Version - - VERSION = '3' - - ## - # Description of this generator - - DESCRIPTION = 'HTML generator, written by Michael Granger' - - ## - # The relative path to style sheets and javascript. By default this is set - # the same as the rel_prefix. - - attr_accessor :asset_rel_path - - ## - # The path to generate files into, combined with --op from the - # options for a full path. - - attr_reader :base_dir - - ## - # Classes and modules to be used by this generator, not necessarily - # displayed. See also #modsort - - attr_reader :classes - - ## - # No files will be written when dry_run is true. - - attr_accessor :dry_run - - ## - # When false the generate methods return a String instead of writing to a - # file. The default is true. - - attr_accessor :file_output - - ## - # Files to be displayed by this generator - - attr_reader :files - - ## - # The JSON index generator for this Darkfish generator - - attr_reader :json_index - - ## - # Methods to be displayed by this generator - - attr_reader :methods - - ## - # Sorted list of classes and modules to be displayed by this generator - - attr_reader :modsort - - ## - # The RDoc::Store that is the source of the generated content - - attr_reader :store - - ## - # The directory where the template files live - - attr_reader :template_dir # :nodoc: - - ## - # The output directory - - attr_reader :outputdir - - ## - # Initialize a few instance variables before we start - - def initialize store, options - @store = store - @options = options - - @asset_rel_path = '' - @base_dir = Pathname.pwd.expand_path - @dry_run = @options.dry_run - @file_output = true - @template_dir = Pathname.new options.template_dir - @template_cache = {} - - @classes = nil - @context = nil - @files = nil - @methods = nil - @modsort = nil - - @json_index = RDoc::Generator::JsonIndex.new self, options - end - - ## - # Output progress information if debugging is enabled - - def debug_msg *msg - return unless $DEBUG_RDOC - $stderr.puts(*msg) - end - - ## - # Directory where generated class HTML files live relative to the output - # dir. - - def class_dir - nil - end - - ## - # Directory where generated class HTML files live relative to the output - # dir. - - def file_dir - nil - end - - ## - # Create the directories the generated docs will live in if they don't - # already exist. - - def gen_sub_directories - @outputdir.mkpath - end - - ## - # Copy over the stylesheet into the appropriate place in the output - # directory. - - def write_style_sheet - debug_msg "Copying static files" - options = { :verbose => $DEBUG_RDOC, :noop => @dry_run } - - BUILTIN_STYLE_ITEMS.each do |item| - install_rdoc_static_file @template_dir + item, "./#{item}", options - end - - unless @options.template_stylesheets.empty? - FileUtils.cp @options.template_stylesheets, '.', **options - end - - Dir[(@template_dir + "{js,images}/**/*").to_s].each do |path| - next if File.directory? path - next if File.basename(path) =~ /^\./ - - dst = Pathname.new(path).relative_path_from @template_dir - - install_rdoc_static_file @template_dir + path, dst, options - end - end - - ## - # Build the initial indices and output objects based on an array of TopLevel - # objects containing the extracted information. - - def generate - setup - - write_style_sheet - generate_index - generate_class_files - generate_file_files - generate_table_of_contents - @json_index.generate - @json_index.generate_gzipped - - copy_static - - rescue => e - debug_msg "%s: %s\n %s" % [ - e.class.name, e.message, e.backtrace.join("\n ") - ] - - raise - end - - ## - # Copies static files from the static_path into the output directory - - def copy_static - return if @options.static_path.empty? - - fu_options = { :verbose => $DEBUG_RDOC, :noop => @dry_run } - - @options.static_path.each do |path| - unless File.directory? path then - FileUtils.install path, @outputdir, **fu_options.merge(:mode => 0644) - next - end - - Dir.chdir path do - Dir[File.join('**', '*')].each do |entry| - dest_file = @outputdir + entry - - if File.directory? entry then - FileUtils.mkdir_p entry, **fu_options - else - FileUtils.install entry, dest_file, **fu_options.merge(:mode => 0644) - end - end - end - end - end - - ## - # Return a list of the documented modules sorted by salience first, then - # by name. - - def get_sorted_module_list classes - classes.select do |klass| - klass.display? - end.sort - end - - ## - # Generate an index page which lists all the classes which are documented. - - def generate_index - setup - - template_file = @template_dir + 'index.rhtml' - return unless template_file.exist? - - debug_msg "Rendering the index page..." - - out_file = @base_dir + @options.op_dir + 'index.html' - rel_prefix = @outputdir.relative_path_from out_file.dirname - search_index_rel_prefix = rel_prefix - search_index_rel_prefix += @asset_rel_path if @file_output - - asset_rel_prefix = rel_prefix + @asset_rel_path - - @title = @options.title - - render_template template_file, out_file do |io| - here = binding - # suppress 1.9.3 warning - here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) - here - end - rescue => e - error = RDoc::Error.new \ - "error generating index.html: #{e.message} (#{e.class})" - error.set_backtrace e.backtrace - - raise error - end - - ## - # Generates a class file for +klass+ - - def generate_class klass, template_file = nil - setup - - current = klass - - template_file ||= @template_dir + 'class.rhtml' - - debug_msg " working on %s (%s)" % [klass.full_name, klass.path] - out_file = @outputdir + klass.path - rel_prefix = @outputdir.relative_path_from out_file.dirname - search_index_rel_prefix = rel_prefix - search_index_rel_prefix += @asset_rel_path if @file_output - - asset_rel_prefix = rel_prefix + @asset_rel_path - svninfo = get_svninfo(current) - - @title = "#{klass.type} #{klass.full_name} - #{@options.title}" - - debug_msg " rendering #{out_file}" - render_template template_file, out_file do |io| - here = binding - # suppress 1.9.3 warning - here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) - here.local_variable_set(:svninfo, svninfo) - here - end - end - - ## - # Generate a documentation file for each class and module - - def generate_class_files - setup - - template_file = @template_dir + 'class.rhtml' - template_file = @template_dir + 'classpage.rhtml' unless - template_file.exist? - return unless template_file.exist? - debug_msg "Generating class documentation in #{@outputdir}" - - current = nil - - @classes.each do |klass| - current = klass - - generate_class klass, template_file - end - rescue => e - error = RDoc::Error.new \ - "error generating #{current.path}: #{e.message} (#{e.class})" - error.set_backtrace e.backtrace - - raise error - end - - ## - # Generate a documentation file for each file - - def generate_file_files - setup - - page_file = @template_dir + 'page.rhtml' - fileinfo_file = @template_dir + 'fileinfo.rhtml' - - # for legacy templates - filepage_file = @template_dir + 'filepage.rhtml' unless - page_file.exist? or fileinfo_file.exist? - - return unless - page_file.exist? or fileinfo_file.exist? or filepage_file.exist? - - debug_msg "Generating file documentation in #{@outputdir}" - - out_file = nil - current = nil - - @files.each do |file| - current = file - - if file.text? and page_file.exist? then - generate_page file - next - end - - template_file = nil - out_file = @outputdir + file.path - debug_msg " working on %s (%s)" % [file.full_name, out_file] - rel_prefix = @outputdir.relative_path_from out_file.dirname - search_index_rel_prefix = rel_prefix - search_index_rel_prefix += @asset_rel_path if @file_output - - asset_rel_prefix = rel_prefix + @asset_rel_path - - unless filepage_file then - if file.text? then - next unless page_file.exist? - template_file = page_file - @title = file.page_name - else - next unless fileinfo_file.exist? - template_file = fileinfo_file - @title = "File: #{file.base_name}" - end - end - - @title += " - #{@options.title}" - template_file ||= filepage_file - - render_template template_file, out_file do |io| - here = binding - # suppress 1.9.3 warning - here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) - here.local_variable_set(:current, current) - here - end - end - rescue => e - error = - RDoc::Error.new "error generating #{out_file}: #{e.message} (#{e.class})" - error.set_backtrace e.backtrace - - raise error - end - - ## - # Generate a page file for +file+ - - def generate_page file - setup - - template_file = @template_dir + 'page.rhtml' - - out_file = @outputdir + file.path - debug_msg " working on %s (%s)" % [file.full_name, out_file] - rel_prefix = @outputdir.relative_path_from out_file.dirname - search_index_rel_prefix = rel_prefix - search_index_rel_prefix += @asset_rel_path if @file_output - - current = file - asset_rel_prefix = rel_prefix + @asset_rel_path - - @title = "#{file.page_name} - #{@options.title}" - - debug_msg " rendering #{out_file}" - render_template template_file, out_file do |io| - here = binding - # suppress 1.9.3 warning - here.local_variable_set(:current, current) - here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) - here - end - end - - ## - # Generates the 404 page for the RDoc servlet - - def generate_servlet_not_found message - setup - - template_file = @template_dir + 'servlet_not_found.rhtml' - return unless template_file.exist? - - debug_msg "Rendering the servlet 404 Not Found page..." - - rel_prefix = rel_prefix = '' - search_index_rel_prefix = rel_prefix - search_index_rel_prefix += @asset_rel_path if @file_output - - asset_rel_prefix = '' - - @title = 'Not Found' - - render_template template_file do |io| - here = binding - # suppress 1.9.3 warning - here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) - here - end - rescue => e - error = RDoc::Error.new \ - "error generating servlet_not_found: #{e.message} (#{e.class})" - error.set_backtrace e.backtrace - - raise error - end - - ## - # Generates the servlet root page for the RDoc servlet - - def generate_servlet_root installed - setup - - template_file = @template_dir + 'servlet_root.rhtml' - return unless template_file.exist? - - debug_msg 'Rendering the servlet root page...' - - rel_prefix = '.' - asset_rel_prefix = rel_prefix - search_index_rel_prefix = asset_rel_prefix - search_index_rel_prefix += @asset_rel_path if @file_output - - @title = 'Local RDoc Documentation' - - render_template template_file do |io| binding end - rescue => e - error = RDoc::Error.new \ - "error generating servlet_root: #{e.message} (#{e.class})" - error.set_backtrace e.backtrace - - raise error - end - - ## - # Generate an index page which lists all the classes which are documented. - - def generate_table_of_contents - setup - - template_file = @template_dir + 'table_of_contents.rhtml' - return unless template_file.exist? - - debug_msg "Rendering the Table of Contents..." - - out_file = @outputdir + 'table_of_contents.html' - rel_prefix = @outputdir.relative_path_from out_file.dirname - search_index_rel_prefix = rel_prefix - search_index_rel_prefix += @asset_rel_path if @file_output - - asset_rel_prefix = rel_prefix + @asset_rel_path - - @title = "Table of Contents - #{@options.title}" - - render_template template_file, out_file do |io| - here = binding - # suppress 1.9.3 warning - here.local_variable_set(:asset_rel_prefix, asset_rel_prefix) - here - end - rescue => e - error = RDoc::Error.new \ - "error generating table_of_contents.html: #{e.message} (#{e.class})" - error.set_backtrace e.backtrace - - raise error - end - - def install_rdoc_static_file source, destination, options # :nodoc: - return unless source.exist? - - begin - FileUtils.mkdir_p File.dirname(destination), **options - - begin - FileUtils.ln source, destination, **options - rescue Errno::EEXIST - FileUtils.rm destination - retry - end - rescue - FileUtils.cp source, destination, **options - end - end - - ## - # Prepares for generation of output from the current directory - - def setup - return if instance_variable_defined? :@outputdir - - @outputdir = Pathname.new(@options.op_dir).expand_path @base_dir - - return unless @store - - @classes = @store.all_classes_and_modules.sort - @files = @store.all_files.sort - @methods = @classes.flat_map { |m| m.method_list }.sort - @modsort = get_sorted_module_list @classes - end - - ## - # Return a string describing the amount of time in the given number of - # seconds in terms a human can understand easily. - - def time_delta_string seconds - return 'less than a minute' if seconds < 60 - return "#{seconds / 60} minute#{seconds / 60 == 1 ? '' : 's'}" if - seconds < 3000 # 50 minutes - return 'about one hour' if seconds < 5400 # 90 minutes - return "#{seconds / 3600} hours" if seconds < 64800 # 18 hours - return 'one day' if seconds < 86400 # 1 day - return 'about one day' if seconds < 172800 # 2 days - return "#{seconds / 86400} days" if seconds < 604800 # 1 week - return 'about one week' if seconds < 1209600 # 2 week - return "#{seconds / 604800} weeks" if seconds < 7257600 # 3 months - return "#{seconds / 2419200} months" if seconds < 31536000 # 1 year - return "#{seconds / 31536000} years" - end - - # %q$Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $" - SVNID_PATTERN = / - \$Id:\s - (\S+)\s # filename - (\d+)\s # rev - (\d{4}-\d{2}-\d{2})\s # Date (YYYY-MM-DD) - (\d{2}:\d{2}:\d{2}Z)\s # Time (HH:MM:SSZ) - (\w+)\s # committer - \$$ - /x - - ## - # Try to extract Subversion information out of the first constant whose - # value looks like a subversion Id tag. If no matching constant is found, - # and empty hash is returned. - - def get_svninfo klass - constants = klass.constants or return {} - - constants.find { |c| c.value =~ SVNID_PATTERN } or return {} - - filename, rev, date, time, committer = $~.captures - commitdate = Time.parse "#{date} #{time}" - - return { - :filename => filename, - :rev => Integer(rev), - :commitdate => commitdate, - :commitdelta => time_delta_string(Time.now - commitdate), - :committer => committer, - } - end - - ## - # Creates a template from its components and the +body_file+. - # - # For backwards compatibility, if +body_file+ contains " - - - -#{head_file.read} - -#{body} - TEMPLATE - end - - ## - # Renders the ERb contained in +file_name+ relative to the template - # directory and returns the result based on the current context. - - def render file_name - template_file = @template_dir + file_name - - template = template_for template_file, false, RDoc::ERBPartial - - template.filename = template_file.to_s - - template.result @context - end - - ## - # Load and render the erb template in the given +template_file+ and write - # it out to +out_file+. - # - # Both +template_file+ and +out_file+ should be Pathname-like objects. - # - # An io will be yielded which must be captured by binding in the caller. - - def render_template template_file, out_file = nil # :yield: io - io_output = out_file && !@dry_run && @file_output - erb_klass = io_output ? RDoc::ERBIO : ERB - - template = template_for template_file, true, erb_klass - - if io_output then - debug_msg "Outputting to %s" % [out_file.expand_path] - - out_file.dirname.mkpath - out_file.open 'w', 0644 do |io| - io.set_encoding @options.encoding - - @context = yield io - - template_result template, @context, template_file - end - else - @context = yield nil - - output = template_result template, @context, template_file - - debug_msg " would have written %d characters to %s" % [ - output.length, out_file.expand_path - ] if @dry_run - - output - end - end - - ## - # Creates the result for +template+ with +context+. If an error is raised a - # Pathname +template_file+ will indicate the file where the error occurred. - - def template_result template, context, template_file - template.filename = template_file.to_s - template.result context - rescue NoMethodError => e - raise RDoc::Error, "Error while evaluating %s: %s" % [ - template_file.expand_path, - e.message, - ], e.backtrace - end - - ## - # Retrieves a cache template for +file+, if present, or fills the cache. - - def template_for file, page = true, klass = ERB - template = @template_cache[file] - - return template if template - - if page then - template = assemble_template file - erbout = 'io' - else - template = file.read - template = template.encode @options.encoding - - file_var = File.basename(file).sub(/\..*/, '') - - erbout = "_erbout_#{file_var}" - end - - template = klass.new template, trim_mode: '-', eoutvar: erbout - @template_cache[file] = template - template - end - - # Returns an excerpt of the content for usage in meta description tags - def excerpt(content) - text = case content - when RDoc::Comment - content.text - when RDoc::Markup::Document - # This case is for page files that are not markdown nor rdoc - # We convert them to markdown for now as it's easier to extract the text - formatter = RDoc::Markup::ToMarkdown.new - formatter.start_accepting - formatter.accept_document(content) - formatter.end_accepting - else - content - end - - # Match from a capital letter to the first period, discarding any links, so - # that we don't end up matching badges in the README - first_paragraph_match = text.match(/[A-Z][^\.:\/]+\./) - return text[0...150].gsub(/\n/, " ").squeeze(" ") unless first_paragraph_match - - extracted_text = first_paragraph_match[0] - second_paragraph = first_paragraph_match.post_match.match(/[A-Z][^\.:\/]+\./) - extracted_text << " " << second_paragraph[0] if second_paragraph - - extracted_text[0...150].gsub(/\n/, " ").squeeze(" ") - end - - def generate_ancestor_list(ancestors, klass) - return '' if ancestors.empty? - - ancestor = ancestors.shift - content = +'
  • ' - - if ancestor.is_a?(RDoc::NormalClass) - content << "#{ancestor.full_name}" - else - content << ancestor.to_s - end - - # Recursively call the method for the remaining ancestors - content << generate_ancestor_list(ancestors, klass) - - content << '
' - end -end diff --git a/lib/rdoc/generator/json_index.rb b/lib/rdoc/generator/json_index.rb deleted file mode 100644 index c454910d5c..0000000000 --- a/lib/rdoc/generator/json_index.rb +++ /dev/null @@ -1,300 +0,0 @@ -# frozen_string_literal: true -require 'json' -begin - require 'zlib' -rescue LoadError -end - -## -# The JsonIndex generator is designed to complement an HTML generator and -# produces a JSON search index. This generator is derived from sdoc by -# Vladimir Kolesnikov and contains verbatim code written by him. -# -# This generator is designed to be used with a regular HTML generator: -# -# class RDoc::Generator::Darkfish -# def initialize options -# # ... -# @base_dir = Pathname.pwd.expand_path -# -# @json_index = RDoc::Generator::JsonIndex.new self, options -# end -# -# def generate -# # ... -# @json_index.generate -# end -# end -# -# == Index Format -# -# The index is output as a JSON file assigned to the global variable -# +search_data+. The structure is: -# -# var search_data = { -# "index": { -# "searchIndex": -# ["a", "b", ...], -# "longSearchIndex": -# ["a", "a::b", ...], -# "info": [ -# ["A", "A", "A.html", "", ""], -# ["B", "A::B", "A::B.html", "", ""], -# ... -# ] -# } -# } -# -# The same item is described across the +searchIndex+, +longSearchIndex+ and -# +info+ fields. The +searchIndex+ field contains the item's short name, the -# +longSearchIndex+ field contains the full_name (when appropriate) and the -# +info+ field contains the item's name, full_name, path, parameters and a -# snippet of the item's comment. -# -# == LICENSE -# -# Copyright (c) 2009 Vladimir Kolesnikov -# -# Permission is hereby granted, free of charge, to any person obtaining -# a copy of this software and associated documentation files (the -# "Software"), to deal in the Software without restriction, including -# without limitation the rights to use, copy, modify, merge, publish, -# distribute, sublicense, and/or sell copies of the Software, and to -# permit persons to whom the Software is furnished to do so, subject to -# the following conditions: -# -# The above copyright notice and this permission notice shall be -# included in all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -class RDoc::Generator::JsonIndex - - include RDoc::Text - - ## - # Where the search index lives in the generated output - - SEARCH_INDEX_FILE = File.join 'js', 'search_index.js' - - attr_reader :index # :nodoc: - - ## - # Creates a new generator. +parent_generator+ is used to determine the - # class_dir and file_dir of links in the output index. - # - # +options+ are the same options passed to the parent generator. - - def initialize parent_generator, options - @parent_generator = parent_generator - @store = parent_generator.store - @options = options - - @template_dir = File.expand_path '../template/json_index', __FILE__ - @base_dir = @parent_generator.base_dir - - @classes = nil - @files = nil - @index = nil - end - - ## - # Builds the JSON index as a Hash. - - def build_index - reset @store.all_files.sort, @store.all_classes_and_modules.sort - - index_classes - index_methods - index_pages - - { :index => @index } - end - - ## - # Output progress information if debugging is enabled - - def debug_msg *msg - return unless $DEBUG_RDOC - $stderr.puts(*msg) - end - - ## - # Writes the JSON index to disk - - def generate - debug_msg "Generating JSON index" - - debug_msg " writing search index to %s" % SEARCH_INDEX_FILE - data = build_index - - return if @options.dry_run - - out_dir = @base_dir + @options.op_dir - index_file = out_dir + SEARCH_INDEX_FILE - - FileUtils.mkdir_p index_file.dirname, :verbose => $DEBUG_RDOC - - index_file.open 'w', 0644 do |io| - io.set_encoding Encoding::UTF_8 - io.write 'var search_data = ' - - JSON.dump data, io, 0 - end - unless ENV['SOURCE_DATE_EPOCH'].nil? - index_file.utime index_file.atime, Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime - end - - Dir.chdir @template_dir do - Dir['**/*.js'].each do |source| - dest = File.join out_dir, source - - FileUtils.install source, dest, :mode => 0644, :preserve => true, :verbose => $DEBUG_RDOC - end - end - end - - ## - # Compress the search_index.js file using gzip - - def generate_gzipped - return if @options.dry_run or not defined?(Zlib) - - debug_msg "Compressing generated JSON index" - out_dir = @base_dir + @options.op_dir - - search_index_file = out_dir + SEARCH_INDEX_FILE - outfile = out_dir + "#{search_index_file}.gz" - - debug_msg "Reading the JSON index file from %s" % search_index_file - search_index = search_index_file.read(mode: 'r:utf-8') - - debug_msg "Writing gzipped search index to %s" % outfile - - Zlib::GzipWriter.open(outfile) do |gz| - gz.mtime = File.mtime(search_index_file) - gz.orig_name = search_index_file.basename.to_s - gz.write search_index - gz.close - end - - # GZip the rest of the js files - Dir.chdir @template_dir do - Dir['**/*.js'].each do |source| - dest = out_dir + source - outfile = out_dir + "#{dest}.gz" - - debug_msg "Reading the original js file from %s" % dest - data = dest.read - - debug_msg "Writing gzipped file to %s" % outfile - - Zlib::GzipWriter.open(outfile) do |gz| - gz.mtime = File.mtime(dest) - gz.orig_name = dest.basename.to_s - gz.write data - gz.close - end - end - end - end - - ## - # Adds classes and modules to the index - - def index_classes - debug_msg " generating class search index" - - documented = @classes.uniq.select do |klass| - klass.document_self_or_methods - end - - documented.each do |klass| - debug_msg " #{klass.full_name}" - record = klass.search_record - @index[:searchIndex] << search_string(record.shift) - @index[:longSearchIndex] << search_string(record.shift) - @index[:info] << record - end - end - - ## - # Adds methods to the index - - def index_methods - debug_msg " generating method search index" - - list = @classes.uniq.flat_map do |klass| - klass.method_list - end.sort_by do |method| - [method.name, method.parent.full_name] - end - - list.each do |method| - debug_msg " #{method.full_name}" - record = method.search_record - @index[:searchIndex] << "#{search_string record.shift}()" - @index[:longSearchIndex] << "#{search_string record.shift}()" - @index[:info] << record - end - end - - ## - # Adds pages to the index - - def index_pages - debug_msg " generating pages search index" - - pages = @files.select do |file| - file.text? - end - - pages.each do |page| - debug_msg " #{page.page_name}" - record = page.search_record - @index[:searchIndex] << search_string(record.shift) - @index[:longSearchIndex] << '' - record.shift - @index[:info] << record - end - end - - ## - # The directory classes are written to - - def class_dir - @parent_generator.class_dir - end - - ## - # The directory files are written to - - def file_dir - @parent_generator.file_dir - end - - def reset files, classes # :nodoc: - @files = files - @classes = classes - - @index = { - :searchIndex => [], - :longSearchIndex => [], - :info => [] - } - end - - ## - # Removes whitespace and downcases +string+ - - def search_string string - string.downcase.gsub(/\s/, '') - end - -end diff --git a/lib/rdoc/generator/markup.rb b/lib/rdoc/generator/markup.rb deleted file mode 100644 index 76b7d458aa..0000000000 --- a/lib/rdoc/generator/markup.rb +++ /dev/null @@ -1,159 +0,0 @@ -# frozen_string_literal: true -## -# Handle common RDoc::Markup tasks for various CodeObjects -# -# This module is loaded by generators. It allows RDoc's CodeObject tree to -# avoid loading generator code to improve startup time for +ri+. - -module RDoc::Generator::Markup - - ## - # Generates a relative URL from this object's path to +target_path+ - - def aref_to(target_path) - RDoc::Markup::ToHtml.gen_relative_url path, target_path - end - - ## - # Generates a relative URL from +from_path+ to this object's path - - def as_href(from_path) - RDoc::Markup::ToHtml.gen_relative_url from_path, path - end - - ## - # Handy wrapper for marking up this object's comment - - def description - markup @comment - end - - ## - # Creates an RDoc::Markup::ToHtmlCrossref formatter - - def formatter - return @formatter if defined? @formatter - - options = @store.rdoc.options - this = RDoc::Context === self ? self : @parent - - @formatter = RDoc::Markup::ToHtmlCrossref.new options, this.path, this - @formatter.code_object = self - @formatter - end - - ## - # Build a webcvs URL starting for the given +url+ with +full_path+ appended - # as the destination path. If +url+ contains '%s' +full_path+ will be - # will replace the %s using sprintf on the +url+. - - def cvs_url(url, full_path) - if /%s/ =~ url then - sprintf url, full_path - else - url + full_path - end - end - -end - -class RDoc::CodeObject - - include RDoc::Generator::Markup - -end - -class RDoc::MethodAttr - - ## - # Prepend +src+ with line numbers. Relies on the first line of a source - # code listing having: - # - # # File xxxxx, line dddd - # - # If it has this comment then line numbers are added to +src+ and the , - # line dddd portion of the comment is removed. - - def add_line_numbers(src) - return unless src.sub!(/\A(.*)(, line (\d+))/, '\1') - first = $3.to_i - 1 - last = first + src.count("\n") - size = last.to_s.length - - line = first - src.gsub!(/^/) do - res = if line == first then - " " * (size + 1) - else - "%2$*1$d " % [size, line] - end - - line += 1 - res - end - end - - ## - # Turns the method's token stream into HTML. - # - # Prepends line numbers if +options.line_numbers+ is true. - - def markup_code - return '' unless @token_stream - - src = RDoc::TokenStream.to_html @token_stream - - # dedent the source - indent = src.length - lines = src.lines.to_a - lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment - lines.each do |line| - if line =~ /^ *(?=\S)/ - n = $~.end(0) - indent = n if n < indent - break if n == 0 - end - end - src.gsub!(/^#{' ' * indent}/, '') if indent > 0 - - add_line_numbers(src) if options.line_numbers - - src - end - -end - -class RDoc::ClassModule - - ## - # Handy wrapper for marking up this class or module's comment - - def description - markup @comment_location - end - -end - -class RDoc::Context::Section - - include RDoc::Generator::Markup - -end - -class RDoc::TopLevel - - ## - # Returns a URL for this source file on some web repository. Use the -W - # command line option to set. - - def cvs_url - url = @store.rdoc.options.webcvs - - if /%s/ =~ url then - url % @relative_name - else - url + @relative_name - end - end - -end diff --git a/lib/rdoc/generator/pot.rb b/lib/rdoc/generator/pot.rb deleted file mode 100644 index b0b7c07179..0000000000 --- a/lib/rdoc/generator/pot.rb +++ /dev/null @@ -1,99 +0,0 @@ -# frozen_string_literal: true -## -# Generates a POT file. -# -# Here is a translator work flow with the generator. -# -# == Create .pot -# -# You create .pot file by pot formatter: -# -# % rdoc --format pot -# -# It generates doc/rdoc.pot. -# -# == Create .po -# -# You create .po file from doc/rdoc.pot. This operation is needed only -# the first time. This work flow assumes that you are a translator -# for Japanese. -# -# You create locale/ja/rdoc.po from doc/rdoc.pot. You can use msginit -# provided by GNU gettext or rmsginit provided by gettext gem. This -# work flow uses gettext gem because it is more portable than GNU -# gettext for Rubyists. Gettext gem is implemented by pure Ruby. -# -# % gem install gettext -# % mkdir -p locale/ja -# % rmsginit --input doc/rdoc.pot --output locale/ja/rdoc.po --locale ja -# -# Translate messages in .po -# -# You translate messages in .po by a PO file editor. po-mode.el exists -# for Emacs users. There are some GUI tools such as GTranslator. -# There are some Web services such as POEditor and Tansifex. You can -# edit by your favorite text editor because .po is a text file. -# Generate localized documentation -# -# You can generate localized documentation with locale/ja/rdoc.po: -# -# % rdoc --locale ja -# -# You can find documentation in Japanese in doc/. Yay! -# -# == Update translation -# -# You need to update translation when your application is added or -# modified messages. -# -# You can update .po by the following command lines: -# -# % rdoc --format pot -# % rmsgmerge --update locale/ja/rdoc.po doc/rdoc.pot -# -# You edit locale/ja/rdoc.po to translate new messages. - -class RDoc::Generator::POT - - RDoc::RDoc.add_generator self - - ## - # Description of this generator - - DESCRIPTION = 'creates .pot file' - - ## - # Set up a new .pot generator - - def initialize store, options #:not-new: - @options = options - @store = store - end - - ## - # Writes .pot to disk. - - def generate - po = extract_messages - pot_path = 'rdoc.pot' - File.open(pot_path, "w") do |pot| - pot.print(po.to_s) - end - end - - # :nodoc: - def class_dir - nil - end - - private - def extract_messages - extractor = MessageExtractor.new(@store) - extractor.extract - end - - require_relative 'pot/message_extractor' - require_relative 'pot/po' - require_relative 'pot/po_entry' - -end diff --git a/lib/rdoc/generator/pot/message_extractor.rb b/lib/rdoc/generator/pot/message_extractor.rb deleted file mode 100644 index 4938858bdc..0000000000 --- a/lib/rdoc/generator/pot/message_extractor.rb +++ /dev/null @@ -1,68 +0,0 @@ -# frozen_string_literal: true -## -# Extracts message from RDoc::Store - -class RDoc::Generator::POT::MessageExtractor - - ## - # Creates a message extractor for +store+. - - def initialize store - @store = store - @po = RDoc::Generator::POT::PO.new - end - - ## - # Extracts messages from +store+, stores them into - # RDoc::Generator::POT::PO and returns it. - - def extract - @store.all_classes_and_modules.each do |klass| - extract_from_klass(klass) - end - @po - end - - private - - def extract_from_klass klass - extract_text(klass.comment_location, klass.full_name) - - klass.each_section do |section, constants, attributes| - extract_text(section.title, "#{klass.full_name}: section title") - section.comments.each do |comment| - extract_text(comment, "#{klass.full_name}: #{section.title}") - end - end - - klass.each_constant do |constant| - extract_text(constant.comment, constant.full_name) - end - - klass.each_attribute do |attribute| - extract_text(attribute.comment, attribute.full_name) - end - - klass.each_method do |method| - extract_text(method.comment, method.full_name) - end - end - - def extract_text text, comment, location = nil - return if text.nil? - - options = { - :extracted_comment => comment, - :references => [location].compact, - } - i18n_text = RDoc::I18n::Text.new(text) - i18n_text.extract_messages do |part| - @po.add(entry(part[:paragraph], options)) - end - end - - def entry msgid, options - RDoc::Generator::POT::POEntry.new(msgid, options) - end - -end diff --git a/lib/rdoc/generator/pot/po.rb b/lib/rdoc/generator/pot/po.rb deleted file mode 100644 index 37d45e5258..0000000000 --- a/lib/rdoc/generator/pot/po.rb +++ /dev/null @@ -1,84 +0,0 @@ -# frozen_string_literal: true -## -# Generates a PO format text - -class RDoc::Generator::POT::PO - - ## - # Creates an object that represents PO format. - - def initialize - @entries = {} - add_header - end - - ## - # Adds a PO entry to the PO. - - def add entry - existing_entry = @entries[entry.msgid] - if existing_entry - entry = existing_entry.merge(entry) - end - @entries[entry.msgid] = entry - end - - ## - # Returns PO format text for the PO. - - def to_s - po = '' - sort_entries.each do |entry| - po += "\n" unless po.empty? - po += entry.to_s - end - po - end - - private - - def add_header - add(header_entry) - end - - def header_entry - comment = <<-COMMENT -SOME DESCRIPTIVE TITLE. -Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER -This file is distributed under the same license as the PACKAGE package. -FIRST AUTHOR , YEAR. - COMMENT - - content = <<-CONTENT -Project-Id-Version: PACKAGE VERSEION -Report-Msgid-Bugs-To: -PO-Revision-Date: YEAR-MO_DA HO:MI+ZONE -Last-Translator: FULL NAME -Language-Team: LANGUAGE -Language: -MIME-Version: 1.0 -Content-Type: text/plain; charset=CHARSET -Content-Transfer-Encoding: 8bit -Plural-Forms: nplurals=INTEGER; plural=EXPRESSION; - CONTENT - - options = { - :msgstr => content, - :translator_comment => comment, - :flags => ['fuzzy'], - } - RDoc::Generator::POT::POEntry.new('', options) - end - - def sort_entries - headers, messages = @entries.values.partition do |entry| - entry.msgid.empty? - end - # TODO: sort by location - sorted_messages = messages.sort_by do |entry| - entry.msgid - end - headers + sorted_messages - end - -end diff --git a/lib/rdoc/generator/pot/po_entry.rb b/lib/rdoc/generator/pot/po_entry.rb deleted file mode 100644 index 7454b29273..0000000000 --- a/lib/rdoc/generator/pot/po_entry.rb +++ /dev/null @@ -1,141 +0,0 @@ -# frozen_string_literal: true -## -# A PO entry in PO - -class RDoc::Generator::POT::POEntry - - # The msgid content - attr_reader :msgid - - # The msgstr content - attr_reader :msgstr - - # The comment content created by translator (PO editor) - attr_reader :translator_comment - - # The comment content extracted from source file - attr_reader :extracted_comment - - # The locations where the PO entry is extracted - attr_reader :references - - # The flags of the PO entry - attr_reader :flags - - ## - # Creates a PO entry for +msgid+. Other values can be specified by - # +options+. - - def initialize msgid, options = {} - @msgid = msgid - @msgstr = options[:msgstr] || "" - @translator_comment = options[:translator_comment] - @extracted_comment = options[:extracted_comment] - @references = options[:references] || [] - @flags = options[:flags] || [] - end - - ## - # Returns the PO entry in PO format. - - def to_s - entry = '' - entry += format_translator_comment - entry += format_extracted_comment - entry += format_references - entry += format_flags - entry += <<-ENTRY -msgid #{format_message(@msgid)} -msgstr #{format_message(@msgstr)} - ENTRY - end - - ## - # Merges the PO entry with +other_entry+. - - def merge other_entry - options = { - :extracted_comment => merge_string(@extracted_comment, - other_entry.extracted_comment), - :translator_comment => merge_string(@translator_comment, - other_entry.translator_comment), - :references => merge_array(@references, - other_entry.references), - :flags => merge_array(@flags, - other_entry.flags), - } - self.class.new(@msgid, options) - end - - private - - def format_comment mark, comment - return '' unless comment - return '' if comment.empty? - - formatted_comment = '' - comment.each_line do |line| - formatted_comment += "#{mark} #{line}" - end - formatted_comment += "\n" unless formatted_comment.end_with?("\n") - formatted_comment - end - - def format_translator_comment - format_comment('#', @translator_comment) - end - - def format_extracted_comment - format_comment('#.', @extracted_comment) - end - - def format_references - return '' if @references.empty? - - formatted_references = '' - @references.sort.each do |file, line| - formatted_references += "\#: #{file}:#{line}\n" - end - formatted_references - end - - def format_flags - return '' if @flags.empty? - - formatted_flags = flags.join(",") - "\#, #{formatted_flags}\n" - end - - def format_message message - return "\"#{escape(message)}\"" unless message.include?("\n") - - formatted_message = '""' - message.each_line do |line| - formatted_message += "\n" - formatted_message += "\"#{escape(line)}\"" - end - formatted_message - end - - def escape string - string.gsub(/["\\\t\n]/) do |special_character| - case special_character - when "\t" - "\\t" - when "\n" - "\\n" - else - "\\#{special_character}" - end - end - end - - def merge_string string1, string2 - [string1, string2].compact.join("\n") - end - - def merge_array array1, array2 - (array1 + array2).uniq - end - -end diff --git a/lib/rdoc/generator/ri.rb b/lib/rdoc/generator/ri.rb deleted file mode 100644 index 1c2f018f97..0000000000 --- a/lib/rdoc/generator/ri.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true -## -# Generates ri data files - -class RDoc::Generator::RI - - RDoc::RDoc.add_generator self - - ## - # Description of this generator - - DESCRIPTION = 'creates ri data files' - - ## - # Set up a new ri generator - - def initialize store, options #:not-new: - @options = options - @store = store - @store.path = '.' - end - - ## - # Writes the parsed data store to disk for use by ri. - - def generate - @store.save - end - -end diff --git a/lib/rdoc/generator/template/darkfish/.document b/lib/rdoc/generator/template/darkfish/.document deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/lib/rdoc/generator/template/darkfish/_footer.rhtml b/lib/rdoc/generator/template/darkfish/_footer.rhtml deleted file mode 100644 index 9791b42901..0000000000 --- a/lib/rdoc/generator/template/darkfish/_footer.rhtml +++ /dev/null @@ -1,5 +0,0 @@ - diff --git a/lib/rdoc/generator/template/darkfish/_head.rhtml b/lib/rdoc/generator/template/darkfish/_head.rhtml deleted file mode 100644 index 9e6fb4f94c..0000000000 --- a/lib/rdoc/generator/template/darkfish/_head.rhtml +++ /dev/null @@ -1,43 +0,0 @@ - - - -<%= h @title %> - -<%- if defined?(klass) -%> - "> - - <%- if klass.comment.empty? -%> - "> - <%- else -%> - "> - <%- end -%> -<%- elsif defined?(file) -%> - - "> -<%- elsif @title -%> - - - <%- if @options.main_page and - main_page = @files.find { |f| f.full_name == @options.main_page } then %> - "> - <%- else -%> - - <%- end -%> -<%- end -%> - - - - - - - - - - - -<%- @options.template_stylesheets.each do |stylesheet| -%> - -<%- end -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml deleted file mode 100644 index 22a12d9e95..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +++ /dev/null @@ -1,19 +0,0 @@ -<%- if !svninfo.empty? then %> - -<%- end -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml deleted file mode 100644 index 06b5542fa1..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +++ /dev/null @@ -1,34 +0,0 @@ - diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml deleted file mode 100644 index 7602076c96..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +++ /dev/null @@ -1,15 +0,0 @@ -<%- unless klass.extends.empty? then %> - -<%- end -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml deleted file mode 100644 index 74869a4b51..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +++ /dev/null @@ -1,9 +0,0 @@ - diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml deleted file mode 100644 index 5b600e5975..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +++ /dev/null @@ -1,15 +0,0 @@ -<%- unless klass.includes.empty? then %> - -<%- end -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml deleted file mode 100644 index faed7e0a94..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +++ /dev/null @@ -1,15 +0,0 @@ - diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml deleted file mode 100644 index d09216a0f6..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +++ /dev/null @@ -1,21 +0,0 @@ -<% if (class_methods = klass.class_method_list.sort).any? %> -
-

Class Methods

-
    - <%- class_methods.each do |meth| -%> -
  • class="calls-super" <%- end %>><%= h meth.name -%>
    • - <%- end -%> -
-
-<% end %> - -<% if (instance_methods = klass.instance_methods.sort).any? %> -
-

Instance Methods

-
    - <%- instance_methods.each do |meth| -%> -
  • class="calls-super" <%- end %>><%= h meth.name -%>
    • - <%- end -%> -
-
-<% end %> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml deleted file mode 100644 index d7f330840a..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml +++ /dev/null @@ -1,11 +0,0 @@ - diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml deleted file mode 100644 index 3f68f0c0dc..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +++ /dev/null @@ -1,32 +0,0 @@ -<%- simple_files = @files.select { |f| f.text? } %> -<%- if defined?(current) -%> - <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name -%> -<%- end -%> -<%- unless simple_files.empty? then -%> - -<%- end -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml deleted file mode 100644 index 6808b2bf87..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +++ /dev/null @@ -1,6 +0,0 @@ -<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? -%> - -<%- end -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml deleted file mode 100644 index afc7f7b88d..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +++ /dev/null @@ -1,14 +0,0 @@ - diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml deleted file mode 100644 index 6dcd2ae81f..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +++ /dev/null @@ -1,11 +0,0 @@ -<%- unless klass.sections.length == 1 then %> - -<%- end -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml deleted file mode 100644 index b1e047b5f7..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +++ /dev/null @@ -1,39 +0,0 @@ -<%- comment = if current.respond_to? :comment_location then - current.comment_location - else - current.comment - end - table = current.parse(comment).table_of_contents.dup - - if table.length > 1 then %> -
-

Table of Contents

- - <%- display_link = proc do |heading| -%> - <%= heading.plain_html %> - <%- end -%> - - <%- list_siblings = proc do -%> - <%- level = table.first&.level -%> - <%- while table.first && table.first.level >= level -%> - <%- heading = table.shift -%> - <%- if table.first.nil? || table.first.level <= heading.level -%> -
  • <% display_link.call heading -%> - <%- else -%> -
  • -
    - <%- display_link.call heading -%> -
      - <% list_siblings.call %> -
    -
    -
    • - <%- end -%> - <%- end -%> - <%- end -%> - -
      - <% list_siblings.call %> -
    -
    -<%- end -%> diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml deleted file mode 100644 index ed2cbe31a0..0000000000 --- a/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +++ /dev/null @@ -1,3 +0,0 @@ - diff --git a/lib/rdoc/generator/template/darkfish/class.rhtml b/lib/rdoc/generator/template/darkfish/class.rhtml deleted file mode 100644 index 0bec9fc9ce..0000000000 --- a/lib/rdoc/generator/template/darkfish/class.rhtml +++ /dev/null @@ -1,206 +0,0 @@ - -<%= render '_sidebar_toggle.rhtml' %> - - - -
    -

    - <%= klass.type %> <%= klass.full_name %> -

    - -
    - <%= klass.description %> -
    - - <%- klass.each_section do |section, constants, attributes| -%> - -<%- end -%> -
    diff --git a/lib/rdoc/generator/template/darkfish/css/fonts.css b/lib/rdoc/generator/template/darkfish/css/fonts.css deleted file mode 100644 index 57302b5183..0000000000 --- a/lib/rdoc/generator/template/darkfish/css/fonts.css +++ /dev/null @@ -1,167 +0,0 @@ -/* - * Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), - * with Reserved Font Name "Source". All Rights Reserved. Source is a - * trademark of Adobe Systems Incorporated in the United States and/or other - * countries. - * - * This Font Software is licensed under the SIL Open Font License, Version - * 1.1. - * - * This license is copied below, and is also available with a FAQ at: - * http://scripts.sil.org/OFL - */ - -@font-face { - font-family: "Source Code Pro"; - font-style: normal; - font-weight: 400; - src: local("Source Code Pro"), - local("SourceCodePro-Regular"), - url("../fonts/SourceCodePro-Regular.ttf") format("truetype"); -} - -@font-face { - font-family: "Source Code Pro"; - font-style: normal; - font-weight: 700; - src: local("Source Code Pro Bold"), - local("SourceCodePro-Bold"), - url("../fonts/SourceCodePro-Bold.ttf") format("truetype"); -} - -/* - * Copyright (c) 2010, Łukasz Dziedzic (dziedzic@typoland.com), - * with Reserved Font Name Lato. - * - * This Font Software is licensed under the SIL Open Font License, Version - * 1.1. - * - * This license is copied below, and is also available with a FAQ at: - * http://scripts.sil.org/OFL - */ - -@font-face { - font-family: "Lato"; - font-style: normal; - font-weight: 300; - src: local("Lato Light"), - local("Lato-Light"), - url("../fonts/Lato-Light.ttf") format("truetype"); -} - -@font-face { - font-family: "Lato"; - font-style: italic; - font-weight: 300; - src: local("Lato Light Italic"), - local("Lato-LightItalic"), - url("../fonts/Lato-LightItalic.ttf") format("truetype"); -} - -@font-face { - font-family: "Lato"; - font-style: normal; - font-weight: 700; - src: local("Lato Regular"), - local("Lato-Regular"), - url("../fonts/Lato-Regular.ttf") format("truetype"); -} - -@font-face { - font-family: "Lato"; - font-style: italic; - font-weight: 700; - src: local("Lato Italic"), - local("Lato-Italic"), - url("../fonts/Lato-RegularItalic.ttf") format("truetype"); -} - -/* - * ----------------------------------------------------------- - * SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 - * ----------------------------------------------------------- - * - * PREAMBLE - * The goals of the Open Font License (OFL) are to stimulate worldwide - * development of collaborative font projects, to support the font creation - * efforts of academic and linguistic communities, and to provide a free and - * open framework in which fonts may be shared and improved in partnership - * with others. - * - * The OFL allows the licensed fonts to be used, studied, modified and - * redistributed freely as long as they are not sold by themselves. The - * fonts, including any derivative works, can be bundled, embedded, - * redistributed and/or sold with any software provided that any reserved - * names are not used by derivative works. The fonts and derivatives, - * however, cannot be released under any other type of license. The - * requirement for fonts to remain under this license does not apply - * to any document created using the fonts or their derivatives. - * - * DEFINITIONS - * "Font Software" refers to the set of files released by the Copyright - * Holder(s) under this license and clearly marked as such. This may - * include source files, build scripts and documentation. - * - * "Reserved Font Name" refers to any names specified as such after the - * copyright statement(s). - * - * "Original Version" refers to the collection of Font Software components as - * distributed by the Copyright Holder(s). - * - * "Modified Version" refers to any derivative made by adding to, deleting, - * or substituting -- in part or in whole -- any of the components of the - * Original Version, by changing formats or by porting the Font Software to a - * new environment. - * - * "Author" refers to any designer, engineer, programmer, technical - * writer or other person who contributed to the Font Software. - * - * PERMISSION & CONDITIONS - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of the Font Software, to use, study, copy, merge, embed, modify, - * redistribute, and sell modified and unmodified copies of the Font - * Software, subject to the following conditions: - * - * 1) Neither the Font Software nor any of its individual components, - * in Original or Modified Versions, may be sold by itself. - * - * 2) Original or Modified Versions of the Font Software may be bundled, - * redistributed and/or sold with any software, provided that each copy - * contains the above copyright notice and this license. These can be - * included either as stand-alone text files, human-readable headers or - * in the appropriate machine-readable metadata fields within text or - * binary files as long as those fields can be easily viewed by the user. - * - * 3) No Modified Version of the Font Software may use the Reserved Font - * Name(s) unless explicit written permission is granted by the corresponding - * Copyright Holder. This restriction only applies to the primary font name as - * presented to the users. - * - * 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font - * Software shall not be used to promote, endorse or advertise any - * Modified Version, except to acknowledge the contribution(s) of the - * Copyright Holder(s) and the Author(s) or with their explicit written - * permission. - * - * 5) The Font Software, modified or unmodified, in part or in whole, - * must be distributed entirely under this license, and must not be - * distributed under any other license. The requirement for fonts to - * remain under this license does not apply to any document created - * using the Font Software. - * - * TERMINATION - * This license becomes null and void if any of the above conditions are - * not met. - * - * DISCLAIMER - * THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT - * OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE - * COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, - * INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL - * DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - * FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM - * OTHER DEALINGS IN THE FONT SOFTWARE. - */ - diff --git a/lib/rdoc/generator/template/darkfish/css/rdoc.css b/lib/rdoc/generator/template/darkfish/css/rdoc.css deleted file mode 100644 index ed9b3e9c3b..0000000000 --- a/lib/rdoc/generator/template/darkfish/css/rdoc.css +++ /dev/null @@ -1,668 +0,0 @@ -/* - * "Darkfish" RDoc CSS - * $Id: rdoc.css 54 2009-01-27 01:09:48Z deveiant $ - * - * Author: Michael Granger - * - */ - -/* vim: ft=css et sw=2 ts=2 sts=2 */ - -/* 1. Variables and Root Styles */ -:root { - --sidebar-width: 300px; - --highlight-color: #cc342d; /* Reddish color for accents and headings */ - --secondary-highlight-color: #c83045; /* Darker reddish color for secondary highlights */ - --text-color: #505050; /* Dark bluish-grey for text */ - --background-color: #fefefe; /* Near white background */ - --code-block-background-color: #f6f6f3; /* Slightly darker grey for code blocks */ - --link-color: #42405F; /* Dark bluish-grey for links */ - --link-hover-color: var(--highlight-color); /* Reddish color on hover */ - --border-color: #e0e0e0;; /* General border color */ - --source-code-toggle-color: var(--secondary-highlight-color); - --scrollbar-thumb-hover-background: #505050; /* Hover color for scrollbar thumb */ - --table-header-background-color: #eceaed; - --table-td-background-color: #f5f4f6; - - /* Font family variables */ - --font-primary: 'Segoe UI', 'Verdana', 'Arial', sans-serif; - --font-heading: 'Helvetica', 'Arial', sans-serif; - --font-code: monospace; -} - -/* 2. Global Styles */ -body { - background: var(--background-color); - font-family: var(--font-primary); - font-weight: 400; - color: var(--text-color); - line-height: 1.6; - - /* Layout */ - display: flex; - flex-direction: column; - min-height: 100vh; - margin: 0; -} - -/* 3. Typography */ -h1 span, -h2 span, -h3 span, -h4 span, -h5 span, -h6 span { - position: relative; - - display: none; - padding-left: 1em; - line-height: 0; - vertical-align: baseline; - font-size: 10px; -} - -h1 span { top: -1.3em; } -h2 span { top: -1.2em; } -h3 span { top: -1.0em; } -h4 span { top: -0.8em; } -h5 span { top: -0.5em; } -h6 span { top: -0.5em; } - -h1:hover span, -h2:hover span, -h3:hover span, -h4:hover span, -h5:hover span, -h6:hover span { - display: inline; -} - -h1:target, -h2:target, -h3:target, -h4:target, -h5:target, -h6:target { - margin-left: -10px; - border-left: 10px solid var(--border-color); - scroll-margin-top: 1rem; -} - -main .anchor-link:target { - scroll-margin-top: 1rem; -} - -/* 4. Links */ -a { - color: var(--link-color); - transition: color 0.3s ease; -} - -a:hover { - color: var(--link-hover-color); -} - -a code:hover { - color: var(--link-hover-color); -} - -/* 5. Code and Pre */ -code, -pre { - font-family: var(--font-code); - background-color: var(--code-block-background-color); - border: 1px solid var(--border-color); - border-radius: 6px; - padding: 16px; - overflow-x: auto; - font-size: 15px; - line-height: 1.5; - margin: 1em 0; -} - -code { - background-color: var(--code-block-background-color); - padding: 0.1em 0.3em; - border-radius: 3px; - font-size: 85%; -} - -/* Tables */ -table { - margin: 0; - border-spacing: 0; - border-collapse: collapse; -} - -table tr th, table tr td { - padding: 0.2em 0.4em; - border: 1px solid var(--border-color); -} - -table tr th { - background-color: var(--table-header-background-color); -} - -table tr:nth-child(even) td { - background-color: var(--table-td-background-color); -} - -/* 7. Navigation and Sidebar */ -nav { - font-family: var(--font-heading); - font-size: 16px; - border-right: 1px solid var(--border-color); - position: fixed; - top: 0; - bottom: 0; - left: 0; - width: var(--sidebar-width); - background: var(--background-color); /* It needs an explicit background for toggling narrow screens */ - overflow-y: auto; - z-index: 10; - display: flex; - flex-direction: column; - color: var(--text-color); -} - -nav[hidden] { - display: none; -} - -nav footer { - padding: 1em; - border-top: 1px solid var(--border-color); -} - -nav footer a { - color: var(--secondary-highlight-color); -} - -nav .nav-section { - margin-top: 1em; - padding: 0 1em; -} - -nav h2, nav h3 { - margin: 0 0 0.5em; - padding: 0.5em 0; - color: var(--highlight-color); - border-bottom: 1px solid var(--border-color); -} - -nav h2 { - font-size: 1.2em; -} - -nav h3, -#table-of-contents-navigation { - font-size: 1em; -} - -nav ul, -nav dl, -nav p { - padding: 0; - list-style: none; - margin: 0.5em 0; -} - -nav ul li { - margin-bottom: 0.3em; -} - -nav ul ul { - padding-left: 1em; -} - -nav ul ul ul { - padding-left: 1em; -} - -nav ul ul ul ul { - padding-left: 1em; -} - -nav a { - color: var(--link-color); - text-decoration: none; -} - -nav a:hover { - color: var(--link-hover-color); - text-decoration: underline; -} - -#navigation-toggle { - z-index: 1000; - font-size: 2em; - display: block; - position: fixed; - top: 10px; - left: 20px; - cursor: pointer; -} - -#navigation-toggle[aria-expanded="true"] { - top: 10px; - left: 250px; -} - -nav ul li details { - position: relative; - padding-right: 1.5em; /* Add space for the marker on the right */ -} - -nav ul li details > summary { - list-style: none; /* Remove the default marker */ - position: relative; /* So that the open/close triangle can position itself absolutely inside */ -} - -nav ul li details > summary::-webkit-details-marker { - display: none; /* Removes the default marker, in Safari 18. */ -} - -nav ul li details > summary::after { - content: '▶'; /* Unicode right-pointing triangle */ - position: absolute; - font-size: 0.8em; - bottom: 0.1em; - margin-left: 0.3em; - transition: transform 0.2s ease; -} - -nav ul li details[open] > summary::after { - transform: rotate(90deg); /* Rotate the triangle when open */ -} - -/* 8. Main Content */ -main { - flex: 1; - display: block; - margin: 3em auto; - padding: 0 2em; - max-width: 800px; - font-size: 16px; - line-height: 1.6; - color: var(--text-color); - box-sizing: border-box; -} - -@media (min-width: 1024px) { - main { - margin-left: var(--sidebar-width); - } - - .table-of-contents main { - margin-left: 20em; - } - - #navigation-toggle { - display: none; - } -} - -main h1[class] { - margin-top: 0; - margin-bottom: 1em; - font-size: 2.5em; - color: var(--highlight-color); -} - -main h1, -main h2, -main h3, -main h4, -main h5, -main h6 { - font-family: var(--font-heading); - color: var(--highlight-color); -} - -/* Search */ -#search-section { - padding: 1em; - background-color: var(--background-color); - border-bottom: 1px solid var(--border-color); -} - -#search-field-wrapper { - position: relative; - display: flex; - align-items: center; -} - -#search-field { - width: 100%; - padding: 0.5em 1em 0.5em 2.5em; - border: 1px solid var(--border-color); - border-radius: 20px; - font-size: 14px; - outline: none; - transition: border-color 0.3s ease; - color: var(--text-color); -} - -#search-field:focus { - border-color: var(--highlight-color); -} - -#search-field::placeholder { - color: var(--text-color); -} - -#search-field-wrapper::before { - content: "\1F50D"; - position: absolute; - left: 0.75em; - top: 50%; - transform: translateY(-50%); - font-size: 14px; - color: var(--text-color); - opacity: 0.6; -} - -/* Search Results */ -#search-results { - font-family: var(--font-primary); - font-weight: 300; -} - -#search-results .search-match { - font-family: var(--font-heading); - font-weight: normal; -} - -#search-results .search-selected { - background: var(--code-block-background-color); - border-bottom: 1px solid transparent; -} - -#search-results li { - list-style: none; - border-bottom: 1px solid var(--border-color); - margin-bottom: 0.5em; -} - -#search-results li:last-child { - border-bottom: none; - margin-bottom: 0; -} - -#search-results li p { - padding: 0; - margin: 0.5em; -} - -#search-results .search-namespace { - font-weight: bold; -} - -#search-results li em { - background-color: rgba(224, 108, 117, 0.1); - font-style: normal; -} - -#search-results pre { - margin: 0.5em; - font-family: var(--font-code); -} - -/* Syntax Highlighting - Gruvbox Light Scheme */ - -.ruby-constant { color: #AF3A03; } /* Dark Orange */ -.ruby-keyword { color: #9D0006; } /* Dark Red */ -.ruby-ivar { color: #B57614; } /* Brown */ -.ruby-operator { color: #427B58; } /* Dark Teal */ -.ruby-identifier { color: #076678; } /* Deep Teal */ -.ruby-node { color: #8F3F71; } /* Plum */ -.ruby-comment { color: #928374; font-style: italic; } /* Gray */ -.ruby-regexp { color: #8F3F71; } /* Plum */ -.ruby-value { color: #AF3A03; } /* Dark Orange */ -.ruby-string { color: #79740E; } /* Olive */ - -/* Emphasis */ -em { - text-decoration-color: rgba(52, 48, 64, 0.25); - text-decoration-line: underline; - text-decoration-style: dotted; -} - -strong, -em { - color: var(--highlight-color); - background-color: rgba(255, 111, 97, 0.1); /* Light red background for emphasis */ -} - -/* Paragraphs */ -main p { - line-height: 1.5em; - font-weight: 400; -} - -/* Preformatted Text */ -main pre { - margin: 1.2em 0.5em; - padding: 1em; - font-size: 0.8em; -} - -/* Horizontal Rules */ -main hr { - margin: 1.5em 1em; - border: 2px solid var(--border-color); -} - -/* Blockquotes */ -main blockquote { - margin: 0 2em 1.2em 1.2em; - padding-left: 0.5em; - border-left: 2px solid var(--border-color); -} - -/* Lists */ -main li > p { - margin: 0.5em; -} - -/* Definition Lists */ -main dl { - margin: 1em 0.5em; -} - -main dt { - line-height: 1.5; /* matches `main p` */ - font-weight: bold; -} - -main dl.note-list dt { - margin-right: 1em; - float: left; -} - -main dl.note-list dt:has(+ dt) { - margin-right: 0.25em; -} - -main dl.note-list dt:has(+ dt)::after { - content: ', '; - font-weight: normal; -} - -main dd { - margin: 0 0 1em 1em; -} - -main dd p:first-child { - margin-top: 0; -} - -/* Headers within Main */ -main header h2 { - margin-top: 2em; - border-width: 0; - border-top: 4px solid var(--border-color); - font-size: 130%; -} - -main header h3 { - margin: 2em 0 1.5em; - border-width: 0; - border-top: 3px solid var(--border-color); - font-size: 120%; -} - -/* Utility Classes */ -.hide { display: none !important; } -.initially-hidden { display: none; } - -/* Table of Contents */ -.table-of-contents ul { - margin: 1em; - list-style: none; -} - -.table-of-contents ul ul { - margin-top: 0.25em; -} - -.table-of-contents ul :link, -.table-of-contents ul :visited { - font-size: 16px; -} - -.table-of-contents li { - margin-bottom: 0.25em; -} - -/* Method Details */ -main .method-source-code { - visibility: hidden; - max-height: 0; - overflow: auto; - transition-duration: 200ms; - transition-delay: 0ms; - transition-property: all; - transition-timing-function: ease-in-out; -} - -main .method-source-code pre { - border-color: var(--source-code-toggle-color); -} - -main .method-source-code.active-menu { - visibility: visible; - max-height: 100vh; -} - -main .method-description .method-calls-super { - color: var(--text-color); - font-weight: bold; -} - -main .method-detail { - margin-bottom: 2.5em; -} - -main .method-detail:target { - margin-left: -10px; - border-left: 10px solid var(--border-color); -} - -main .method-header { - display: inline-block; -} - -main .method-heading { - position: relative; - font-family: var(--font-code); - font-size: 110%; - font-weight: bold; -} - -main .method-heading::after { - content: '¶'; - position: absolute; - visibility: hidden; - color: var(--highlight-color); - font-size: 0.5em; -} - -main .method-heading:hover::after { - visibility: visible; -} - -main .method-controls { - line-height: 20px; - float: right; - color: var(--source-code-toggle-color); - cursor: pointer; -} - -main .method-description, -main .aliases { - margin-top: 0.75em; - color: var(--text-color); -} - -main .aliases { - padding-top: 4px; - font-style: italic; - cursor: default; -} - -main .aliases a { - color: var(--secondary-highlight-color); -} - -main .mixin-from { - font-size: 80%; - font-style: italic; - margin-bottom: 0.75em; -} - -main .method-description ul { - margin-left: 1.5em; -} - -main #attribute-method-details .method-detail:hover { - background-color: transparent; - cursor: default; -} - -main .attribute-access-type { - text-transform: uppercase; -} - -/* Responsive Adjustments */ -@media (max-width: 480px) { - nav { - width: 100%; - } - - main { - margin: 1em auto; - padding: 0 1em; - max-width: 100%; - } - - #navigation-toggle { - right: 10px; - left: auto; - } - - #navigation-toggle[aria-expanded="true"] { - left: auto; - } - - table { - display: block; - overflow-x: auto; - white-space: nowrap; - } - - main .method-controls { - margin-top: 10px; - float: none; - } -} diff --git a/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf b/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf deleted file mode 100644 index b49dd43729..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf b/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf deleted file mode 100644 index 7959fef075..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf b/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf deleted file mode 100644 index 839cd589dc..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf b/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf deleted file mode 100644 index bababa09e3..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf b/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf deleted file mode 100644 index dd00982d49..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf b/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf deleted file mode 100644 index 1decfb95af..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/add.png b/lib/rdoc/generator/template/darkfish/images/add.png deleted file mode 100644 index 6332fefea4..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/add.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/arrow_up.png b/lib/rdoc/generator/template/darkfish/images/arrow_up.png deleted file mode 100644 index 1ebb193243..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/arrow_up.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/brick.png b/lib/rdoc/generator/template/darkfish/images/brick.png deleted file mode 100644 index 7851cf34c9..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/brick.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/brick_link.png b/lib/rdoc/generator/template/darkfish/images/brick_link.png deleted file mode 100644 index 9ebf013a23..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/brick_link.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/bug.png b/lib/rdoc/generator/template/darkfish/images/bug.png deleted file mode 100644 index 2d5fb90ec6..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/bug.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/bullet_black.png b/lib/rdoc/generator/template/darkfish/images/bullet_black.png deleted file mode 100644 index 57619706d1..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/bullet_black.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png b/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png deleted file mode 100644 index b47ce55f68..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png b/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png deleted file mode 100644 index 9ab4a89664..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/date.png b/lib/rdoc/generator/template/darkfish/images/date.png deleted file mode 100644 index 783c83357f..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/date.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/delete.png b/lib/rdoc/generator/template/darkfish/images/delete.png deleted file mode 100644 index 08f249365a..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/delete.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/find.png b/lib/rdoc/generator/template/darkfish/images/find.png deleted file mode 100644 index 1547479646..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/find.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif b/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif deleted file mode 100644 index 82290f4833..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png b/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png deleted file mode 100644 index c6473b324e..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/package.png b/lib/rdoc/generator/template/darkfish/images/package.png deleted file mode 100644 index da3c2a2d74..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/package.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/page_green.png b/lib/rdoc/generator/template/darkfish/images/page_green.png deleted file mode 100644 index de8e003f9f..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/page_green.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/page_white_text.png b/lib/rdoc/generator/template/darkfish/images/page_white_text.png deleted file mode 100644 index 813f712f72..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/page_white_text.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/page_white_width.png b/lib/rdoc/generator/template/darkfish/images/page_white_width.png deleted file mode 100644 index 1eb880947d..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/page_white_width.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/plugin.png b/lib/rdoc/generator/template/darkfish/images/plugin.png deleted file mode 100644 index 6187b15aec..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/plugin.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/ruby.png b/lib/rdoc/generator/template/darkfish/images/ruby.png deleted file mode 100644 index f763a16880..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/ruby.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/tag_blue.png b/lib/rdoc/generator/template/darkfish/images/tag_blue.png deleted file mode 100644 index 3f02b5f8f8..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/tag_blue.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/tag_green.png b/lib/rdoc/generator/template/darkfish/images/tag_green.png deleted file mode 100644 index 83ec984bd7..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/tag_green.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/transparent.png b/lib/rdoc/generator/template/darkfish/images/transparent.png deleted file mode 100644 index d665e179ef..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/transparent.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/wrench.png b/lib/rdoc/generator/template/darkfish/images/wrench.png deleted file mode 100644 index 5c8213fef5..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/wrench.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/wrench_orange.png b/lib/rdoc/generator/template/darkfish/images/wrench_orange.png deleted file mode 100644 index 565a9330e0..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/wrench_orange.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/images/zoom.png b/lib/rdoc/generator/template/darkfish/images/zoom.png deleted file mode 100644 index 908612e394..0000000000 Binary files a/lib/rdoc/generator/template/darkfish/images/zoom.png and /dev/null differ diff --git a/lib/rdoc/generator/template/darkfish/index.rhtml b/lib/rdoc/generator/template/darkfish/index.rhtml deleted file mode 100644 index a5c0dd54da..0000000000 --- a/lib/rdoc/generator/template/darkfish/index.rhtml +++ /dev/null @@ -1,23 +0,0 @@ - -<%= render '_sidebar_toggle.rhtml' %> - - - -
    -<%- if @options.main_page and - main_page = @files.find { |f| f.full_name == @options.main_page } then %> -<%= main_page.description %> -<%- else -%> -

    This is the API documentation for <%= h @title %>. -<%- end -%> -

    diff --git a/lib/rdoc/generator/template/darkfish/js/darkfish.js b/lib/rdoc/generator/template/darkfish/js/darkfish.js deleted file mode 100644 index 4c15efde66..0000000000 --- a/lib/rdoc/generator/template/darkfish/js/darkfish.js +++ /dev/null @@ -1,120 +0,0 @@ -/** - * - * Darkfish Page Functions - * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $ - * - * Author: Michael Granger - * - */ - -/* Provide console simulation for firebug-less environments */ -/* -if (!("console" in window) || !("firebug" in console)) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml", - "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"]; - - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -}; -*/ - - -function showSource( e ) { - var target = e.target; - while (!target.classList.contains('method-detail')) { - target = target.parentNode; - } - if (typeof target !== "undefined" && target !== null) { - target = target.querySelector('.method-source-code'); - } - if (typeof target !== "undefined" && target !== null) { - target.classList.toggle('active-menu') - } -}; - -function hookSourceViews() { - document.querySelectorAll('.method-source-toggle').forEach(function (codeObject) { - codeObject.addEventListener('click', showSource); - }); -}; - -function hookSearch() { - var input = document.querySelector('#search-field'); - var result = document.querySelector('#search-results'); - result.classList.remove("initially-hidden"); - - var search_section = document.querySelector('#search-section'); - search_section.classList.remove("initially-hidden"); - - var search = new Search(search_data, input, result); - - search.renderItem = function(result) { - var li = document.createElement('li'); - var html = ''; - - // TODO add relative path to >, yield_arg' - @attr = RDoc::Attr.new nil, 'attr', 'RW', '' - - @klass.add_method @meth - @klass.add_method @meth_bang - @klass.add_method @meth_with_html_tag_yield - @klass.add_attribute @attr - - @ignored = @top_level.add_class RDoc::NormalClass, 'Ignored' - @ignored.ignore - - @store.complete :private - - @object = @store.find_class_or_module 'Object' - @klass_alias = @store.find_class_or_module 'Klass::A' - end - - def teardown - super - - $LOAD_PATH.shift - Dir.chdir @pwd - FileUtils.rm_rf @tmpdir - end - - def test_generate - top_level = @store.add_file 'file.rb' - top_level.add_class @klass.class, @klass.name - @klass.add_class RDoc::NormalClass, 'Inner' - @klass.add_comment <<~RDOC, top_level - = Heading 1 - Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - == Heading 1.1 - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - === Heading 1.1.1 - quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo - ==== Heading 1.1.1.1 - consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse - == Heading 1.2 - cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat - == Heading 1.3 - non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - === Heading 1.3.1 - etc etc... - RDOC - - @g.generate - - assert_file 'index.html' - assert_file 'Object.html' - assert_file 'Klass.html' - assert_file 'Klass/Inner.html' - assert_file 'table_of_contents.html' - assert_file 'js/search_index.js' - - assert_hard_link 'css/rdoc.css' - assert_hard_link 'css/fonts.css' - - assert_hard_link 'fonts/SourceCodePro-Bold.ttf' - assert_hard_link 'fonts/SourceCodePro-Regular.ttf' - - encoding = Regexp.escape Encoding::UTF_8.name - - assert_match %r%%, File.binread('index.html') - assert_match %r%%, File.binread('Object.html') - - refute_match(/Ignored/, File.binread('index.html')) - summary = File.binread('index.html')[%r[.*]m] - assert_match(%r[Klass/Inner\.html".*>Inner<], summary) - - klass = File.binread('Klass.html') - klassnav = klass[%r[
    .*]m] - assert_match( - %r[
  • \s*
    \s*\s*Heading 1\s*\s*\s*Heading 1.1.1.1\s*\s*
    \s*
    • ]m, - klassnav - ) - - assert_match(/

    Heading 1(?!\.)/, - klass[%r[
    .*
    ]m]) - toc = File.binread('table_of_contents.html') - assert_match( - %r[Heading 1]m, - toc[%r[.*(?=outer.*?]m - assert_match(re, index) - summary = index[re] - assert_match %r[inner], summary - re = %r[
    outer.*?
    ]m - assert_match(re, File.binread('outer_rdoc.html')) - re = %r[
    outer.*?
    ]m - assert_match(re, File.binread('outer/inner_rdoc.html')) - end - - def test_generate_dry_run - @g.dry_run = true - top_level = @store.add_file 'file.rb' - top_level.add_class @klass.class, @klass.name - - @g.generate - - refute_file 'index.html' - refute_file 'Object.html' - end - - def test_generate_static - FileUtils.mkdir_p 'dir/images' - FileUtils.touch 'dir/images/image.png' - FileUtils.mkdir_p 'file' - FileUtils.touch 'file/file.txt' - - @options.static_path = [ - File.expand_path('dir'), - File.expand_path('file/file.txt'), - ] - - @g.generate - - assert_file 'images/image.png' - assert_file 'file.txt' - end - - def test_generate_static_dry_run - FileUtils.mkdir 'static' - FileUtils.touch 'static/image.png' - - @options.static_path = [File.expand_path('static')] - @g.dry_run = true - - @g.generate - - refute_file 'image.png' - end - - def test_install_rdoc_static_file - src = Pathname File.expand_path(__FILE__, @pwd) - dst = File.join @tmpdir, File.basename(src) - options = {} - - @g.install_rdoc_static_file src, dst, options - - assert_file dst - assert_hard_link dst - end - - def test_install_rdoc_static_file_missing - src = Pathname(__FILE__) + 'nonexistent' - dst = File.join @tmpdir, File.basename(src) - options = {} - - @g.install_rdoc_static_file src, dst, options - - refute_file dst - end - - def test_setup - @g.setup - - assert_equal [@klass_alias, @ignored, @klass, @object], - @g.classes.sort_by { |klass| klass.full_name } - assert_equal [@top_level], @g.files - assert_equal [@meth, @meth, @meth_bang, @meth_bang, @meth_with_html_tag_yield, @meth_with_html_tag_yield], @g.methods - assert_equal [@klass_alias, @klass, @object], @g.modsort - end - - def test_template_for - classpage = Pathname.new @options.template_dir + 'class.rhtml' - - template = @g.send(:template_for, classpage, true, RDoc::ERBIO) - assert_kind_of RDoc::ERBIO, template - - assert_same template, @g.send(:template_for, classpage) - end - - def test_template_for_dry_run - classpage = Pathname.new @options.template_dir + 'class.rhtml' - - template = @g.send(:template_for, classpage, true, ERB) - assert_kind_of ERB, template - - assert_same template, @g.send(:template_for, classpage) - end - - def test_template_for_partial - partial = Pathname.new @options.template_dir + '_sidebar_classes.rhtml' - - template = @g.send(:template_for, partial, false, RDoc::ERBPartial) - - assert_kind_of RDoc::ERBPartial, template - - assert_same template, @g.send(:template_for, partial) - end - - def test_generated_method_with_html_tag_yield - top_level = @store.add_file 'file.rb' - top_level.add_class @klass.class, @klass.name - - @g.generate - - path = File.join @tmpdir, 'A.html' - - f = open(path) - internal_file = f.read - method_name_index = internal_file.index('method_with_html_tag_yield') - last_of_method_name_index = method_name_index + internal_file[method_name_index..-1].index('
    ') - 1 - method_name = internal_file[method_name_index..last_of_method_name_index] - f.close - - assert_includes method_name, '{ |%<<script>alert("atui")</script>>, yield_arg| ... }' - end - - def test_generated_filename_with_html_tag - filename = '">should be escaped' - begin # in @tmpdir - File.write(filename, '') - rescue SystemCallError - # ", <, > chars are prohibited as filename - return - else - File.unlink(filename) - end - @store.add_file filename - doc = @store.all_files.last - doc.parser = RDoc::Parser::Simple - - @g.generate - - Dir.glob("*.html", base: @tmpdir) do |html| - File.binread(File.join(@tmpdir, html)).scan(/.*should be escaped.*/) do |line| - assert_not_include line, "", html - end - end - end - - def test_template_stylesheets - css = Tempfile.create(%W'hoge .css', Dir.mktmpdir('tmp', '.')) - File.write(css, '') - css.close - base = File.basename(css) - refute_file(base) - - @options.template_stylesheets << css - - @g.generate - - assert_file base - assert_include File.binread('index.html'), %Q[href="./#{base}"] - end - - def test_title - title = "RDoc Test".freeze - @options.title = title - @g.generate - - assert_main_title(File.binread('index.html'), title) - end - - def test_title_escape - title = %[].freeze - @options.title = title - @g.generate - - assert_main_title(File.binread('index.html'), title) - end - - def test_meta_tags_for_index - @options.title = "My awesome Ruby project" - @g.generate - - content = File.binread("index.html") - - assert_include(content, '') - assert_include(content, '') - end - - def test_meta_tags_for_classes - top_level = @store.add_file("file.rb") - top_level.add_class(@klass.class, @klass.name) - inner = @klass.add_class(RDoc::NormalClass, "Inner") - inner.add_comment("This is a normal class. It is fully documented.", top_level) - - @g.generate - - content = File.binread("Klass/Inner.html") - assert_include(content, '') - assert_include( - content, - '', - ) - end - - def test_meta_tags_for_rdoc_files - top_level = @store.add_file("CONTRIBUTING.rdoc", parser: RDoc::Parser::Simple) - top_level.comment = <<~RDOC - = Contributing - - Here are the instructions for contributing. Begin by installing Ruby. - RDOC - - @g.generate - - content = File.binread("CONTRIBUTING_rdoc.html") - assert_include(content, '') - assert_include( - content, - "", - ) - end - - def test_meta_tags_for_markdown_files - top_level = @store.add_file("MyPage.md", parser: RDoc::Parser::Markdown) - top_level.comment = <<~MARKDOWN - # MyPage - - This is a comment - MARKDOWN - - @g.generate - - content = File.binread("MyPage_md.html") - assert_include(content, '') - assert_include( - content, - '', - ) - end - - def test_meta_tags_for_raw_pages - top_level = @store.add_file("MyPage", parser: RDoc::Parser::Simple) - top_level.comment = RDoc::Markup::Document.new(RDoc::Markup::Paragraph.new('this is a comment')) - - @g.generate - - content = File.binread("MyPage.html") - assert_include(content, '') - assert_include( - content, - '', - ) - end - - def test_meta_tags_for_empty_document - top_level = @store.add_file("MyPage", parser: RDoc::Parser::Simple) - top_level.comment = RDoc::Markup::Document.new - - @g.generate - - content = File.binread("MyPage.html") - assert_include(content, '') - assert_include( - content, - '', - ) - end - - ## - # Asserts that +filename+ has a link count greater than 1 if hard links to - # @tmpdir are supported. - - def assert_hard_link filename - assert_file filename - - src = @g.template_dir + '_head.rhtml' - dst = File.join @tmpdir, 'hardlinktest' - - begin - FileUtils.ln src, dst - nlink = File.stat(dst).nlink if File.identical? src, dst - FileUtils.rm dst - return if nlink == 1 - rescue SystemCallError - return - end - - assert_operator File.stat(filename).nlink, :>, 1, - "#{filename} is not hard-linked" - end - - def assert_main_title(content, title) - title = CGI.escapeHTML(title) - assert_equal(title, content[%r[(.*?)<\/title>]im, 1]) - assert_include(content[%r[<main\s[^<>]*+>\s*(.*?)</main>]im, 1], title) - end -end diff --git a/test/rdoc/test_rdoc_generator_json_index.rb b/test/rdoc/test_rdoc_generator_json_index.rb deleted file mode 100644 index 71b5cd969a..0000000000 --- a/test/rdoc/test_rdoc_generator_json_index.rb +++ /dev/null @@ -1,371 +0,0 @@ -# coding: US-ASCII -# frozen_string_literal: true - -require_relative 'helper' - -class TestRDocGeneratorJsonIndex < RDoc::TestCase - - def setup - super - - @tmpdir = Dir.mktmpdir "test_rdoc_generator_darkfish_#{$$}_" - FileUtils.mkdir_p @tmpdir - - @options = RDoc::Options.new - @options.files = [] - # JsonIndex is used in conjunction with another generator - @options.setup_generator 'darkfish' - @options.template_dir = '' - @options.op_dir = @tmpdir - @options.option_parser = OptionParser.new - @options.finish - - @darkfish = RDoc::Generator::Darkfish.new @store, @options - @g = RDoc::Generator::JsonIndex.new @darkfish, @options - - @rdoc.options = @options - @rdoc.generator = @g - - @top_level = @store.add_file 'file.rb' - @top_level.parser = RDoc::Parser::Ruby - - @klass = @top_level.add_class RDoc::NormalClass, 'C' - - @meth = @klass.add_method RDoc::AnyMethod.new(nil, 'meth') - @meth.record_location @top_level - - @nest_klass = @klass.add_class RDoc::NormalClass, 'D' - @nest_klass.record_location @top_level - - @nest_meth = @nest_klass.add_method RDoc::AnyMethod.new(nil, 'meth') - - @ignored = @top_level.add_class RDoc::NormalClass, 'Ignored' - @ignored.ignore - - @page = @store.add_file 'page.rdoc' - @page.parser = RDoc::Parser::Simple - - @top_levels = [@top_level, @page].sort - @klasses = [@klass, @nest_klass, @ignored] - - Dir.chdir @tmpdir - end - - def teardown - super - - Dir.chdir @pwd - FileUtils.rm_rf @tmpdir - end - - def test_build_index - index = @g.build_index - - expected = { - :index => { - :searchIndex => %w[c d meth() meth() page], - :longSearchIndex => %w[c c::d c#meth() c::d#meth()], - :info => [ - @klass.search_record[2..-1], - @nest_klass.search_record[2..-1], - @meth.search_record[2..-1], - @nest_meth.search_record[2..-1], - @page.search_record[2..-1], - ], - }, - } - - expected[:index][:longSearchIndex] << '' - - assert_equal expected, index - end - - def test_class_dir - assert_equal @darkfish.class_dir, @g.class_dir - end - - def test_file_dir - assert_equal @darkfish.file_dir, @g.file_dir - end - - def test_generate - @g.generate - - assert_file 'js/searcher.js' - assert_file 'js/navigation.js' - assert_file 'js/search_index.js' - - srcdir = File.expand_path('lib/rdoc', @pwd) - if !File.directory? srcdir - # for Ruby core repository - srcdir = File.expand_path("../../../lib/rdoc", __FILE__) - end - - orig_file = Pathname(File.join srcdir, 'generator/template/json_index/js/navigation.js') - generated_file = Pathname(File.join @tmpdir, 'js/navigation.js') - - # The following assertion for the generated file's modified time randomly - # fails in a ppc64le environment. - # https://github.com/ruby/rdoc/issues/1048 - if orig_file.mtime.inspect != generated_file.mtime.inspect && - RUBY_PLATFORM =~ /powerpc64le/ - pend <<~EOC - Unstable test in ppc64le. - <#{orig_file.mtime.inspect}> expected but was - <#{generated_file.mtime.inspect}>. - EOC - end - - # This is dirty hack on JRuby - assert_equal orig_file.mtime.inspect, generated_file.mtime.inspect, - '.js files should be the same timestamp of original' - - json = File.read 'js/search_index.js' - - json =~ /\Avar search_data = / - - assignment = $& - index = $' - - refute_empty assignment - - index = JSON.parse index - - info = [ - @klass.search_record[2..-1], - @nest_klass.search_record[2..-1], - @meth.search_record[2..-1], - @nest_meth.search_record[2..-1], - @page.search_record[2..-1], - ] - - expected = { - 'index' => { - 'searchIndex' => [ - 'c', - 'd', - 'meth()', - 'meth()', - 'page', - ], - 'longSearchIndex' => [ - 'c', - 'c::d', - 'c#meth()', - 'c::d#meth()', - '', - ], - 'info' => info, - }, - } - - assert_equal expected, index - end - - def test_generate_search_index_with_reproducible_builds - backup_epoch = ENV['SOURCE_DATE_EPOCH'] - ruby_birthday = Time.parse 'Wed, 24 Feb 1993 21:00:00 +0900' - ENV['SOURCE_DATE_EPOCH'] = ruby_birthday.to_i.to_s - - @g.generate - - assert_file 'js/search_index.js' - generated_search_index = Pathname(File.join @tmpdir, 'js/search_index.js') - assert_equal ruby_birthday, generated_search_index.mtime - - ENV['SOURCE_DATE_EPOCH'] = backup_epoch - end - - def test_generate_gzipped - begin - require 'zlib' - rescue LoadError - omit "no zlib" - end - @g.generate - @g.generate_gzipped - - assert_file 'js/searcher.js' - assert_file 'js/searcher.js.gz' - assert_file 'js/navigation.js' - assert_file 'js/navigation.js.gz' - assert_file 'js/search_index.js' - assert_file 'js/search_index.js.gz' - - json = File.open('js/search_index.js.gz', 'rb') {|gzip| - Zlib::GzipReader.new(gzip).read - } - - json =~ /\Avar search_data = / - - assignment = $& - index = $' - - refute_empty assignment - - index = JSON.parse index - - info = [ - @klass.search_record[2..-1], - @nest_klass.search_record[2..-1], - @meth.search_record[2..-1], - @nest_meth.search_record[2..-1], - @page.search_record[2..-1], - ] - - expected = { - 'index' => { - 'searchIndex' => [ - 'c', - 'd', - 'meth()', - 'meth()', - 'page', - ], - 'longSearchIndex' => [ - 'c', - 'c::d', - 'c#meth()', - 'c::d#meth()', - '', - ], - 'info' => info, - }, - } - - assert_equal expected, index - end - - def test_generate_utf_8 - # JRuby fails this test with: - # Encoding::UndefinedConversionError: "\xC2" from ASCII-8BIT to UTF-8 - # org/jruby/RubyIO.java:1639:in `write' - # org/jruby/RubyIO.java:1612:in `write' - # json/ext/GeneratorState.java:232:in `_generate' - # json/ext/GeneratorState.java:137:in `generate' - # /Users/runner/work/rdoc/rdoc/vendor/bundle/jruby/3.1.0/gems/json-2.9.0-java/lib/json/common.rb:824:in `dump' - # /Users/runner/work/rdoc/rdoc/lib/rdoc/generator/json_index.rb:148:in `block in generate' - omit if RUBY_PLATFORM =~ /java/ - - text = "5\xB0" - text = RDoc::Encoding.change_encoding text, Encoding::ISO_8859_1 - @klass.add_comment comment(text), @top_level - - @g.generate - - json = File.read 'js/search_index.js' - json.force_encoding Encoding::UTF_8 - - json =~ /\Avar search_data = / - - index = $' - - index = JSON.parse index - - klass_record = @klass.search_record[2..-1] - klass_record[-1] = "<p>5\xc2\xb0\n" - klass_record[-1] = RDoc::Encoding.change_encoding klass_record[-1], Encoding::UTF_8 - - info = [ - klass_record, - @nest_klass.search_record[2..-1], - @meth.search_record[2..-1], - @nest_meth.search_record[2..-1], - @page.search_record[2..-1], - ] - - expected = { - 'index' => { - 'searchIndex' => [ - 'c', - 'd', - 'meth()', - 'meth()', - 'page', - ], - 'longSearchIndex' => [ - 'c', - 'c::d', - 'c#meth()', - 'c::d#meth()', - '', - ], - 'info' => info, - }, - } - - assert_equal expected, index - end - - def test_index_classes - @g.reset @top_levels, @klasses - - @g.index_classes - - expected = { - :searchIndex => %w[c d], - :longSearchIndex => %w[c c::d], - :info => [ - @klass.search_record[2..-1], - @nest_klass.search_record[2..-1], - ], - } - - assert_equal expected, @g.index - end - - def test_index_classes_nodoc - @klass.document_self = false - @nest_klass.document_self = false - @meth.document_self = false - @nest_meth.document_self = false - - @g.reset @top_levels, @klasses - - @g.index_classes - - expected = { - :searchIndex => [], - :longSearchIndex => [], - :info => [], - } - - assert_equal expected, @g.index - end - - def test_index_methods - @g.reset @top_levels, @klasses - - @g.index_methods - - expected = { - :searchIndex => %w[meth() meth()], - :longSearchIndex => %w[c#meth() c::d#meth()], - :info => [ - @meth.search_record[2..-1], - @nest_meth.search_record[2..-1], - ], - } - - assert_equal expected, @g.index - end - - def test_index_pages - @g.reset @top_levels, @klasses - - @g.index_pages - - expected = { - :searchIndex => %w[page], - :longSearchIndex => [''], - :info => [@page.search_record[2..-1]], - } - - assert_equal expected, @g.index - end - - def test_search_string - assert_equal 'cd', @g.search_string('C d') - end - -end diff --git a/test/rdoc/test_rdoc_generator_markup.rb b/test/rdoc/test_rdoc_generator_markup.rb deleted file mode 100644 index 7c021e432e..0000000000 --- a/test/rdoc/test_rdoc_generator_markup.rb +++ /dev/null @@ -1,59 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocGeneratorMarkup < RDoc::TestCase - - include RDoc::Text - include RDoc::Generator::Markup - - attr_reader :store - - def setup - super - - @options = RDoc::Options.new - @rdoc.options = @options - - @parent = self - @path = '/index.html' - @symbols = {} - end - - def test_aref_to - assert_equal 'Foo/Bar.html', aref_to('Foo/Bar.html') - end - - def test_as_href - assert_equal '../index.html', as_href('Foo/Bar.html') - end - - def test_cvs_url - assert_equal 'http://example/this_page', - cvs_url('http://example/', 'this_page') - - assert_equal 'http://example/?page=this_page&foo=bar', - cvs_url('http://example/?page=%s&foo=bar', 'this_page') - end - - def test_description - @comment = '= Hello' - - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", description - end - - def test_formatter - assert_kind_of RDoc::Markup::ToHtmlCrossref, formatter - refute formatter.show_hash - assert_same self, formatter.context - end - - attr_reader :path - - def find_symbol name - @symbols[name] - end - -end diff --git a/test/rdoc/test_rdoc_generator_pot.rb b/test/rdoc/test_rdoc_generator_pot.rb deleted file mode 100644 index bafe9ecca5..0000000000 --- a/test/rdoc/test_rdoc_generator_pot.rb +++ /dev/null @@ -1,92 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocGeneratorPOT < RDoc::TestCase - - def setup - super - - @options = RDoc::Options.new - @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_pot_#{$$}" - FileUtils.mkdir_p @tmpdir - - @generator = RDoc::Generator::POT.new @store, @options - - @top_level = @store.add_file 'file.rb' - @klass = @top_level.add_class RDoc::NormalClass, 'Object' - @klass.add_comment 'This is a class', @top_level - @klass.add_section 'This is a section', comment('This is a section comment') - - @const = RDoc::Constant.new "CONSTANT", "29", "This is a constant" - - @meth = RDoc::AnyMethod.new nil, 'method' - @meth.record_location @top_level - @meth.comment = 'This is a method' - - @attr = RDoc::Attr.new nil, 'attr', 'RW', '' - @attr.record_location @top_level - @attr.comment = 'This is an attribute' - - @klass.add_constant @const - @klass.add_method @meth - @klass.add_attribute @attr - - Dir.chdir @tmpdir - end - - def teardown - super - - Dir.chdir @pwd - FileUtils.rm_rf @tmpdir - end - - def test_generate - @generator.generate - - assert_equal <<-POT, File.read(File.join(@tmpdir, 'rdoc.pot')) -# SOME DESCRIPTIVE TITLE. -# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER -# This file is distributed under the same license as the PACKAGE package. -# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: PACKAGE VERSEION\\n" -"Report-Msgid-Bugs-To:\\n" -"PO-Revision-Date: YEAR-MO_DA HO:MI+ZONE\\n" -"Last-Translator: FULL NAME <EMAIL@ADDRESS>\\n" -"Language-Team: LANGUAGE <LL@li.org>\\n" -"Language:\\n" -"MIME-Version: 1.0\\n" -"Content-Type: text/plain; charset=CHARSET\\n" -"Content-Transfer-Encoding: 8bit\\n" -"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\\n" - -#. Object -msgid "This is a class" -msgstr "" - -#. Object::CONSTANT -msgid "This is a constant" -msgstr "" - -#. Object#method -msgid "This is a method" -msgstr "" - -#. Object: section title -msgid "This is a section" -msgstr "" - -#. Object: This is a section -msgid "This is a section comment" -msgstr "" - -#. Object#attr -msgid "This is an attribute" -msgstr "" - POT - end - -end diff --git a/test/rdoc/test_rdoc_generator_pot_po.rb b/test/rdoc/test_rdoc_generator_pot_po.rb deleted file mode 100644 index 7696a1f5b1..0000000000 --- a/test/rdoc/test_rdoc_generator_pot_po.rb +++ /dev/null @@ -1,52 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocGeneratorPOTPO < RDoc::TestCase - - def setup - super - @po = RDoc::Generator::POT::PO.new - end - - def test_empty - assert_equal header, @po.to_s - end - - def test_have_entry - @po.add(entry("Hello", {})) - assert_equal <<-PO, @po.to_s -#{header} -msgid "Hello" -msgstr "" - PO - end - - private - - def entry(msgid, options) - RDoc::Generator::POT::POEntry.new(msgid, options) - end - - def header - <<-'HEADER' -# SOME DESCRIPTIVE TITLE. -# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER -# This file is distributed under the same license as the PACKAGE package. -# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: PACKAGE VERSEION\n" -"Report-Msgid-Bugs-To:\n" -"PO-Revision-Date: YEAR-MO_DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" -"Language-Team: LANGUAGE <LL@li.org>\n" -"Language:\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=CHARSET\n" -"Content-Transfer-Encoding: 8bit\n" -"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n" - HEADER - end - -end diff --git a/test/rdoc/test_rdoc_generator_pot_po_entry.rb b/test/rdoc/test_rdoc_generator_pot_po_entry.rb deleted file mode 100644 index d3d6271b23..0000000000 --- a/test/rdoc/test_rdoc_generator_pot_po_entry.rb +++ /dev/null @@ -1,140 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocGeneratorPOTPOEntry < RDoc::TestCase - - def test_msgid_normal - assert_equal <<-'ENTRY', entry("Hello", {}).to_s -msgid "Hello" -msgstr "" - ENTRY - end - - def test_msgid_multiple_lines - assert_equal <<-'ENTRY', entry("Hello\nWorld", {}).to_s -msgid "" -"Hello\n" -"World" -msgstr "" - ENTRY - end - - def test_msgid_tab - assert_equal <<-'ENTRY', entry("Hello\tWorld", {}).to_s -msgid "Hello\tWorld" -msgstr "" - ENTRY - end - - def test_msgid_back_slash - assert_equal <<-'ENTRY', entry("Hello \\ World", {}).to_s -msgid "Hello \\ World" -msgstr "" - ENTRY - end - - def test_msgid_double_quote - assert_equal <<-'ENTRY', entry("Hello \"World\"!", {}).to_s -msgid "Hello \"World\"!" -msgstr "" - ENTRY - end - - def test_translator_comment_normal - options = {:translator_comment => "Greeting"} - assert_equal <<-'ENTRY', entry("Hello", options).to_s -# Greeting -msgid "Hello" -msgstr "" - ENTRY - end - - def test_translator_comment_multiple_lines - options = {:translator_comment => "Greeting\nfor morning"} - assert_equal <<-'ENTRY', entry("Hello", options).to_s -# Greeting -# for morning -msgid "Hello" -msgstr "" - ENTRY - end - - def test_extracted_comment_normal - options = {:extracted_comment => "Object"} - assert_equal <<-'ENTRY', entry("Hello", options).to_s -#. Object -msgid "Hello" -msgstr "" - ENTRY - end - - def test_extracted_comment_multiple_lines - options = {:extracted_comment => "Object\nMorning#greeting"} - assert_equal <<-'ENTRY', entry("Hello", options).to_s -#. Object -#. Morning#greeting -msgid "Hello" -msgstr "" - ENTRY - end - - def test_references_normal - options = {:references => [["lib/rdoc.rb", 29]]} - assert_equal <<-'ENTRY', entry("Hello", options).to_s -#: lib/rdoc.rb:29 -msgid "Hello" -msgstr "" - ENTRY - end - - def test_references_multiple - options = {:references => [["lib/rdoc.rb", 29], ["lib/rdoc/i18n.rb", 9]]} - assert_equal <<-'ENTRY', entry("Hello", options).to_s -#: lib/rdoc.rb:29 -#: lib/rdoc/i18n.rb:9 -msgid "Hello" -msgstr "" - ENTRY - end - - def test_flags_normal - options = {:flags => ["fuzzy"]} - assert_equal <<-'ENTRY', entry("Hello", options).to_s -#, fuzzy -msgid "Hello" -msgstr "" - ENTRY - end - - def test_flags_multiple - options = {:flags => ["fuzzy", "ruby-format"]} - assert_equal <<-'ENTRY', entry("Hello", options).to_s -#, fuzzy,ruby-format -msgid "Hello" -msgstr "" - ENTRY - end - - def test_full - options = { - :translator_comment => "Greeting", - :extracted_comment => "Morning#greeting", - :references => [["lib/rdoc.rb", 29]], - :flags => ["fuzzy"], - } - assert_equal <<-'ENTRY', entry("Hello", options).to_s -# Greeting -#. Morning#greeting -#: lib/rdoc.rb:29 -#, fuzzy -msgid "Hello" -msgstr "" - ENTRY - end - - private - def entry(msgid, options) - RDoc::Generator::POT::POEntry.new(msgid, options) - end - -end diff --git a/test/rdoc/test_rdoc_generator_ri.rb b/test/rdoc/test_rdoc_generator_ri.rb deleted file mode 100644 index 195c0d2482..0000000000 --- a/test/rdoc/test_rdoc_generator_ri.rb +++ /dev/null @@ -1,76 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocGeneratorRI < RDoc::TestCase - - def setup - super - - @options = RDoc::Options.new - @options.encoding = Encoding::UTF_8 - @store.encoding = Encoding::UTF_8 - - @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_ri_#{$$}" - FileUtils.mkdir_p @tmpdir - - @g = RDoc::Generator::RI.new @store, @options - - @top_level = @store.add_file 'file.rb' - @klass = @top_level.add_class RDoc::NormalClass, 'Object' - - @meth = RDoc::AnyMethod.new nil, 'method' - @meth.record_location @top_level - - @meth_bang = RDoc::AnyMethod.new nil, 'method!' - @meth_bang.record_location @top_level - - @attr = RDoc::Attr.new nil, 'attr', 'RW', '' - @attr.record_location @top_level - - @klass.add_method @meth - @klass.add_method @meth_bang - @klass.add_attribute @attr - - Dir.chdir @tmpdir - end - - def teardown - super - - Dir.chdir @pwd - FileUtils.rm_rf @tmpdir - end - - def test_generate - @g.generate - - assert_file File.join(@tmpdir, 'cache.ri') - - assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri') - - assert_file File.join(@tmpdir, 'Object', 'attr-i.ri') - assert_file File.join(@tmpdir, 'Object', 'method-i.ri') - assert_file File.join(@tmpdir, 'Object', 'method%21-i.ri') - - store = RDoc::RI::Store.new @tmpdir - store.load_cache - - encoding = Encoding::UTF_8 - - assert_equal encoding, store.encoding - end - - def test_generate_dry_run - @store.dry_run = true - @g = RDoc::Generator::RI.new @store, @options - - top_level = @store.add_file 'file.rb' - top_level.add_class @klass.class, @klass.name - - @g.generate - - refute_file File.join(@tmpdir, 'cache.ri') - refute_file File.join(@tmpdir, 'Object') - end - -end diff --git a/test/rdoc/test_rdoc_i18n_locale.rb b/test/rdoc/test_rdoc_i18n_locale.rb deleted file mode 100644 index 746d659c67..0000000000 --- a/test/rdoc/test_rdoc_i18n_locale.rb +++ /dev/null @@ -1,74 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocI18nLocale < RDoc::TestCase - - def setup - super - @locale = locale('fr') - - @tmpdir = File.join Dir.tmpdir, "test_rdoc_i18n_locale_#{$$}" - FileUtils.mkdir_p @tmpdir - - @locale_dir = @tmpdir - end - - def teardown - FileUtils.rm_rf @tmpdir - super - end - - def test_name - assert_equal 'fr', locale('fr').name - end - - def test_load_nonexistent_po - locale = File.join(@locale_dir, 'nonexsitent-locale') - refute_file locale - refute @locale.load(locale) - end - - def test_load_existent_po - begin - require 'gettext/po_parser' - rescue LoadError - omit 'gettext gem is not found' - end - - fr_locale_dir = File.join @locale_dir, 'fr' - FileUtils.mkdir_p fr_locale_dir - File.open File.join(fr_locale_dir, 'rdoc.po'), 'w' do |po| - po.puts <<-PO -msgid "" -msgstr "" -"Language: fr\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" - -msgid "Hello" -msgstr "Bonjour" - PO - end - - assert @locale.load(@locale_dir) - assert_equal 'Bonjour', @locale.translate('Hello') - end - - def test_translate_existent_message - messages = @locale.instance_variable_get(:@messages) - messages['Hello'] = 'Bonjour' - assert_equal 'Bonjour', @locale.translate('Hello') - end - - def test_translate_nonexistent_message - assert_equal 'Hello', @locale.translate('Hello') - end - - private - - def locale(name) - RDoc::I18n::Locale.new(name) - end - -end diff --git a/test/rdoc/test_rdoc_i18n_text.rb b/test/rdoc/test_rdoc_i18n_text.rb deleted file mode 100644 index 89b7e97708..0000000000 --- a/test/rdoc/test_rdoc_i18n_text.rb +++ /dev/null @@ -1,124 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocI18nText < RDoc::TestCase - - def test_multiple_paragraphs - paragraph1 = <<-PARAGRAPH.strip -RDoc produces HTML and command-line documentation for Ruby projects. RDoc -includes the +rdoc+ and +ri+ tools for generating and displaying documentation -from the command-line. - PARAGRAPH - - paragraph2 = <<-PARAGRAPH.strip -This command generates documentation for all the Ruby and C source -files in and below the current directory. These will be stored in a -documentation tree starting in the subdirectory +doc+. - PARAGRAPH - - raw = <<-RAW -#{paragraph1} - -#{paragraph2} - RAW - - expected = [ - { - :type => :paragraph, - :paragraph => paragraph1, - :line_no => 1, - }, - { - :type => :paragraph, - :paragraph => paragraph2, - :line_no => 5, - }, - ] - assert_equal expected, extract_messages(raw) - end - - def test_translate_multiple_paragraphs - paragraph1 = <<-PARAGRAPH.strip -Paragraph 1. - PARAGRAPH - paragraph2 = <<-PARAGRAPH.strip -Paragraph 2. - PARAGRAPH - - raw = <<-RAW -#{paragraph1} - -#{paragraph2} - RAW - - expected = <<-TRANSLATED -Paragraphe 1. - -Paragraphe 2. - TRANSLATED - assert_equal expected, translate(raw) - end - - def test_translate_not_translated_message - nonexistent_paragraph = <<-PARAGRAPH.strip -Nonexistent paragraph. - PARAGRAPH - - raw = <<-RAW -#{nonexistent_paragraph} - RAW - - expected = <<-TRANSLATED -#{nonexistent_paragraph} - TRANSLATED - assert_equal expected, translate(raw) - end - - def test_translate_keep_empty_lines - raw = <<-RAW -Paragraph 1. - - - - -Paragraph 2. - RAW - - expected = <<-TRANSLATED -Paragraphe 1. - - - - -Paragraphe 2. - TRANSLATED - assert_equal expected, translate(raw) - end - - private - - def extract_messages(raw) - text = RDoc::I18n::Text.new(raw) - messages = [] - text.extract_messages do |message| - messages << message - end - messages - end - - def locale - locale = RDoc::I18n::Locale.new('fr') - messages = locale.instance_variable_get(:@messages) - messages['markdown'] = 'markdown (markdown in fr)' - messages['Hello'] = 'Bonjour (Hello in fr)' - messages['Paragraph 1.'] = 'Paragraphe 1.' - messages['Paragraph 2.'] = 'Paragraphe 2.' - locale - end - - def translate(raw) - text = RDoc::I18n::Text.new(raw) - text.translate(locale) - end - -end diff --git a/test/rdoc/test_rdoc_include.rb b/test/rdoc/test_rdoc_include.rb deleted file mode 100644 index 380464f6cc..0000000000 --- a/test/rdoc/test_rdoc_include.rb +++ /dev/null @@ -1,109 +0,0 @@ -# frozen_string_literal: true -require_relative 'xref_test_case' - -class TestRDocInclude < XrefTestCase - - def setup - super - - @inc = RDoc::Include.new 'M1', 'comment' - @inc.parent = @m1 - @inc.record_location @top_level - @inc.store = @store - end - - def test_module - assert_equal @m1, @inc.module - assert_equal 'Unknown', RDoc::Include.new('Unknown', 'comment').module - end - - def test_module_extended - m1 = @xref_data.add_module RDoc::NormalModule, 'Mod1' - m1_m3 = m1.add_module RDoc::NormalModule, 'Mod3' - m1_m2 = m1.add_module RDoc::NormalModule, 'Mod2' - m1_m2_m3 = m1_m2.add_module RDoc::NormalModule, 'Mod3' - m1_m2_m3_m4 = m1_m2_m3.add_module RDoc::NormalModule, 'Mod4' - m1_m2_m4 = m1_m2.add_module RDoc::NormalModule, 'Mod4' - m1_m2_k0 = m1_m2.add_class RDoc::NormalClass, 'Klass0' - m1_m2_k0_m4 = m1_m2_k0.add_module RDoc::NormalModule, 'Mod4' - #m1_m2_k0_m4_m5 = m1_m2_k0_m4.add_module RDoc::NormalModule, 'Mod5' - m1_m2_k0_m4_m6 = m1_m2_k0_m4.add_module RDoc::NormalModule, 'Mod6' - m1_m2_k0_m5 = m1_m2_k0.add_module RDoc::NormalModule, 'Mod5' - - i0_m4 = RDoc::Include.new 'Mod4', nil - i0_m5 = RDoc::Include.new 'Mod5', nil - i0_m6 = RDoc::Include.new 'Mod6', nil - i0_m1 = RDoc::Include.new 'Mod1', nil - i0_m2 = RDoc::Include.new 'Mod2', nil - i0_m3 = RDoc::Include.new 'Mod3', nil - - m1_m2_k0.add_include i0_m4 - m1_m2_k0.add_include i0_m5 - m1_m2_k0.add_include i0_m6 - m1_m2_k0.add_include i0_m1 - m1_m2_k0.add_include i0_m2 - m1_m2_k0.add_include i0_m3 - - assert_equal [i0_m4, i0_m5, i0_m6, i0_m1, i0_m2, i0_m3], m1_m2_k0.includes - assert_equal [m1_m2_m3, m1_m2, m1, m1_m2_k0_m4_m6, m1_m2_k0_m5, - m1_m2_k0_m4, @object, 'BasicObject'], m1_m2_k0.ancestors - - m1_k1 = m1.add_class RDoc::NormalClass, 'Klass1' - - i1_m1 = RDoc::Include.new 'Mod1', nil - i1_m2 = RDoc::Include.new 'Mod2', nil - i1_m3 = RDoc::Include.new 'Mod3', nil - i1_m4 = RDoc::Include.new 'Mod4', nil - i1_k0_m4 = RDoc::Include.new 'Klass0::Mod4', nil - - m1_k1.add_include i1_m1 - m1_k1.add_include i1_m2 - m1_k1.add_include i1_m3 - m1_k1.add_include i1_m4 - m1_k1.add_include i1_k0_m4 - - assert_equal [i1_m1, i1_m2, i1_m3, i1_m4, i1_k0_m4], m1_k1.includes - assert_equal [m1_m2_k0_m4, m1_m2_m3_m4, m1_m2_m3, m1_m2, m1, @object, - 'BasicObject'], m1_k1.ancestors - - m1_k2 = m1.add_class RDoc::NormalClass, 'Klass2' - - i2_m1 = RDoc::Include.new 'Mod1', nil - i2_m2 = RDoc::Include.new 'Mod2', nil - i2_m3 = RDoc::Include.new 'Mod3', nil - i2_k0_m4 = RDoc::Include.new 'Klass0::Mod4', nil - - m1_k2.add_include i2_m1 - m1_k2.add_include i2_m3 - m1_k2.add_include i2_m2 - m1_k2.add_include i2_k0_m4 - - assert_equal [i2_m1, i2_m3, i2_m2, i2_k0_m4], m1_k2.includes - assert_equal [m1_m2_k0_m4, m1_m2, m1_m3, m1, @object, 'BasicObject'], - m1_k2.ancestors - - m1_k3 = m1.add_class RDoc::NormalClass, 'Klass3' - - i3_m1 = RDoc::Include.new 'Mod1', nil - i3_m2 = RDoc::Include.new 'Mod2', nil - i3_m4 = RDoc::Include.new 'Mod4', nil - - m1_k3.add_include i3_m1 - m1_k3.add_include i3_m2 - m1_k3.add_include i3_m4 - - assert_equal [i3_m1, i3_m2, i3_m4], m1_k3.includes - assert_equal [m1_m2_m4, m1_m2, m1, @object, 'BasicObject'], m1_k3.ancestors - end - - def test_store_equals - incl = RDoc::Include.new 'M', nil - incl.record_location RDoc::TopLevel.new @top_level.name - - incl.store = @store - - assert_same @top_level, incl.file - assert_same @store, incl.file.store - end - -end diff --git a/test/rdoc/test_rdoc_markdown.rb b/test/rdoc/test_rdoc_markdown.rb deleted file mode 100644 index 72587caf46..0000000000 --- a/test/rdoc/test_rdoc_markdown.rb +++ /dev/null @@ -1,1122 +0,0 @@ -# coding: UTF-8 -# frozen_string_literal: true - -require_relative 'helper' -require_relative '../../lib/rdoc/markup/block_quote' -require_relative '../../lib/rdoc/markdown' - -class TestRDocMarkdown < RDoc::TestCase - - def setup - super - - @RM = RDoc::Markup - - @parser = RDoc::Markdown.new - - @to_html = RDoc::Markup::ToHtml.new(RDoc::Options.new, nil) - end - - def test_class_parse - doc = RDoc::Markdown.parse "hello\n\nworld" - - expected = doc(para("hello"), para("world")) - - assert_equal expected, doc - end - - def test_emphasis - assert_equal '_word_', @parser.emphasis('word') - assert_equal '<em>two words</em>', @parser.emphasis('two words') - assert_equal '<em>*bold*</em>', @parser.emphasis('*bold*') - end - - def test_parse_auto_link_email - doc = parse "Autolink: <nobody-0+_./!%~$@example>" - - expected = doc(para("Autolink: mailto:nobody-0+_./!%~$@example")) - - assert_equal expected, doc - end - - def test_parse_auto_link_url - doc = parse "Autolink: <http://example>" - - expected = doc(para("Autolink: http://example")) - - assert_equal expected, doc - end - - def test_parse_block_quote - doc = parse <<-BLOCK_QUOTE -> this is -> a block quote - BLOCK_QUOTE - - expected = - doc( - block( - para("this is\na block quote"))) - - assert_equal expected, doc - end - - def test_parse_block_quote_continue - doc = parse <<-BLOCK_QUOTE -> this is -a block quote - BLOCK_QUOTE - - expected = - doc( - block( - para("this is\na block quote"))) - - assert_equal expected, doc - end - - def test_parse_block_quote_list - doc = parse <<-BLOCK_QUOTE -> text -> -> * one -> * two - BLOCK_QUOTE - - expected = - doc( - block( - para("text"), - list(:BULLET, - item(nil, para("one")), - item(nil, para("two"))))) - - assert_equal expected, doc - end - - def test_parse_block_quote_newline - doc = parse <<-BLOCK_QUOTE -> this is -a block quote - - BLOCK_QUOTE - - expected = - doc( - block( - para("this is\na block quote"))) - - assert_equal expected, doc - end - - def test_parse_block_quote_separate - doc = parse <<-BLOCK_QUOTE -> this is -a block quote - -> that continues - BLOCK_QUOTE - - expected = - doc( - block( - para("this is\na block quote"), - para("that continues"))) - - assert_equal expected, doc - end - - def test_parse_char_entity - doc = parse 'π &nn;' - - expected = doc(para('π &nn;')) - - assert_equal expected, doc - end - - def test_parse_code - doc = parse "Code: `text`" - - expected = doc(para("Code: <code>text</code>")) - - assert_equal expected, doc - end - - def test_parse_code_github - doc = <<-MD -Example: - -``` -code goes here -``` - MD - - expected = - doc( - para("Example:"), - verb("code goes here\n")) - - assert_equal expected, parse(doc) - assert_equal expected, parse(doc.sub(/^\n/, '')) - - @parser.github = false - - expected = - doc(para("Example:"), - para("<code>\n""code goes here\n</code>")) - - assert_equal expected, parse(doc) - - expected = - doc(para("Example:\n<code>\n""code goes here\n</code>")) - - assert_equal expected, parse(doc.sub(/^\n/, '')) - end - - def test_parse_code_github_format - doc = <<-MD -Example: - -``` ruby -code goes here -``` - MD - - code = verb("code goes here\n") - code.format = :ruby - - expected = - doc( - para("Example:"), - code) - - assert_equal expected, parse(doc) - assert_equal expected, parse(doc.sub(/^\n/, '')) - - @parser.github = false - - expected = - doc(para("Example:"), - para("<code>ruby\n""code goes here\n</code>")) - - assert_equal expected, parse(doc) - - expected = - doc(para("Example:\n<code>ruby\n""code goes here\n</code>")) - - assert_equal expected, parse(doc.sub(/^\n/, '')) - end - - def test_parse_definition_list - doc = parse <<-MD -one -: This is a definition - -two -: This is another definition - MD - - expected = doc( - list(:NOTE, - item(%w[one], para("This is a definition")), - item(%w[two], para("This is another definition")))) - - assert_equal expected, doc - end - - def test_parse_definition_list_indents - doc = parse <<-MD -zero -: Indented zero characters - -one - : Indented one characters - -two - : Indented two characters - -three - : Indented three characters - -four - : Indented four characters - - MD - - expected = doc( - list(:NOTE, - item(%w[zero], para("Indented zero characters")), - item(%w[one], para("Indented one characters")), - item(%w[two], para("Indented two characters")), - item(%w[three], para("Indented three characters"))), - para("four\n : Indented four characters")) - - assert_equal expected, doc - end - - def test_parse_definition_list_multi_description - doc = parse <<-MD -label -: This is a definition - -: This is another definition - MD - - expected = doc( - list(:NOTE, - item(%w[label], para("This is a definition")), - item(nil, para("This is another definition")))) - - assert_equal expected, doc - end - - def test_parse_definition_list_multi_label - doc = parse <<-MD -one -two -: This is a definition - MD - - expected = doc( - list(:NOTE, - item(%w[one two], para("This is a definition")))) - - assert_equal expected, doc - end - - def test_parse_definition_list_multi_line - doc = parse <<-MD -one -: This is a definition -that extends to two lines - -two -: This is another definition -that also extends to two lines - MD - - expected = doc( - list(:NOTE, - item(%w[one], - para("This is a definition\nthat extends to two lines")), - item(%w[two], - para("This is another definition\nthat also extends to two lines")))) - - assert_equal expected, doc - end - - def test_parse_definition_list_rich_label - doc = parse <<-MD -`one` -: This is a definition - -**two** -: This is another definition - MD - - expected = doc( - list(:NOTE, - item(%w[<code>one</code>], - para("This is a definition")), - item(%w[*two*], - para("This is another definition")))) - - assert_equal expected, doc - end - - def test_parse_definition_list_no - @parser.definition_lists = false - - doc = parse <<-MD -one -: This is a definition - -two -: This is another definition - MD - - expected = doc( - para("one\n: This is a definition"), - para("two\n: This is another definition")) - - assert_equal expected, doc - end - - def test_parse_entity_dec - doc = parse "Entity: A" - - expected = doc(para("Entity: A")) - - assert_equal expected, doc - end - - def test_parse_entity_hex - doc = parse "Entity: A" - - expected = doc(para("Entity: A")) - - assert_equal expected, doc - end - - def test_parse_entity_named - doc = parse "Entity: π" - - expected = doc(para("Entity: π")) - - assert_equal expected, doc - end - - def test_parse_emphasis_star - doc = parse "it *works*\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it _works_")) - - assert_equal expected, doc - end - - def test_parse_emphasis_underscore - doc = parse "it _works_\n" - - expected = - doc( - para("it _works_")) - - assert_equal expected, doc - end - - def test_parse_emphasis_underscore_embedded - doc = parse "foo_bar bar_baz\n" - - expected = - doc( - para("foo_bar bar_baz")) - - assert_equal expected, doc - end - - def test_parse_emphasis_underscore_in_word - doc = parse "it foo_bar_baz\n" - - expected = - doc( - para("it foo_bar_baz")) - - assert_equal expected, doc - end - - def test_parse_escape - assert_equal doc(para("Backtick: `")), parse("Backtick: \\`") - - assert_equal doc(para("Backslash: \\")), parse("Backslash: \\\\") - - assert_equal doc(para("Colon: :")), parse("Colon: \\:") - end - - def test_parse_heading_atx - # CommonMark Example 62 - (1..6).each do |level| - doc = parse "#{"#" * level} heading\n" - - expected = @RM::Document.new( - @RM::Heading.new(level, "heading")) - - assert_equal expected, doc - end - - # CommonMark Example 64 - doc = parse "#5 bolt\n\n#hashtag\n" - - expected = @RM::Document.new( - para("#5 bolt"), - para("#hashtag"), - ) - - assert_equal expected, doc - end - - def test_parse_heading_setext_dash - doc = parse <<-MD -heading ---- - MD - - expected = @RM::Document.new( - @RM::Heading.new(2, "heading")) - - assert_equal expected, doc - end - - def test_parse_heading_setext_equals - doc = parse <<-MD -heading -=== - MD - - expected = @RM::Document.new( - @RM::Heading.new(1, "heading")) - - assert_equal expected, doc - end - - def test_parse_html - @parser.html = true - - doc = parse "<address>Links here</address>\n" - - expected = doc( - @RM::Raw.new("<address>Links here</address>")) - - assert_equal expected, doc - end - - def test_parse_html_hr - @parser.html = true - - doc = parse "<hr>\n" - - expected = doc(raw("<hr>")) - - assert_equal expected, doc - end - - def test_parse_html_no_html - @parser.html = false - - doc = parse "<address>Links here</address>\n" - - expected = doc() - - assert_equal expected, doc - end - - def test_parse_image - doc = parse "image ![alt text](path/to/image.jpg)" - - expected = doc(para("image rdoc-image:path/to/image.jpg")) - - assert_equal expected, doc - end - - def test_parse_image_link - @parser.html = true - - doc = parse "[![alt text](path/to/image.jpg)](http://example.com)" - - expected = - doc( - para('{rdoc-image:path/to/image.jpg}[http://example.com]')) - - assert_equal expected, doc - end - - def test_parse_line_break - doc = parse "Some text \nwith extra lines" - - expected = doc( - para("Some text", hard_break, "with extra lines")) - - assert_equal expected, doc - end - - def test_parse_link_reference_id - doc = parse <<-MD -This is [an example][id] reference-style link. - -[id]: http://example.com "Optional Title Here" - MD - - expected = doc( - para("This is {an example}[http://example.com] reference-style link.")) - - assert_equal expected, doc - end - - def test_parse_link_reference_id_adjacent - doc = parse <<-MD -[this] [this] should work - -[this]: example - MD - - expected = doc( - para("{this}[example] should work")) - - assert_equal expected, doc - end - - def test_parse_link_reference_id_eof - doc = parse <<-MD.chomp -This is [an example][id] reference-style link. - -[id]: http://example.com "Optional Title Here" - MD - - expected = doc( - para("This is {an example}[http://example.com] reference-style link.")) - - assert_equal expected, doc - end - - def test_parse_link_reference_id_many - doc = parse <<-MD -This is [an example][id] reference-style link. - -And [another][id]. - -[id]: http://example.com "Optional Title Here" - MD - - expected = doc( - para("This is {an example}[http://example.com] reference-style link."), - para("And {another}[http://example.com].")) - - assert_equal expected, doc - end - - def test_parse_link_reference_implicit - doc = parse <<-MD -This is [an example][] reference-style link. - -[an example]: http://example.com "Optional Title Here" - MD - - expected = doc( - para("This is {an example}[http://example.com] reference-style link.")) - - assert_equal expected, doc - end - - def test_parse_list_bullet - doc = parse <<-MD -* one -* two - MD - - expected = doc( - list(:BULLET, - item(nil, para("one")), - item(nil, para("two")))) - - assert_equal expected, doc - end - - def test_parse_list_bullet_auto_link - doc = parse <<-MD -* <http://example/> - MD - - expected = doc( - list(:BULLET, - item(nil, para("http://example/")))) - - assert_equal expected, doc - end - - def test_parse_list_bullet_continue - doc = parse <<-MD -* one - -* two - MD - - expected = doc( - list(:BULLET, - item(nil, para("one")), - item(nil, para("two")))) - - assert_equal expected, doc - end - - def test_parse_list_bullet_multiline - doc = parse <<-MD -* one - two - MD - - expected = doc( - list(:BULLET, - item(nil, para("one\n two")))) - - assert_equal expected, doc - end - - def test_parse_list_bullet_nest - doc = parse <<-MD -* outer - * inner - MD - - expected = doc( - list(:BULLET, - item(nil, - para("outer"), - list(:BULLET, - item(nil, - para("inner")))))) - - assert_equal expected, doc - end - - def test_parse_list_bullet_nest_loose - doc = parse <<-MD -* outer - - * inner - MD - - expected = doc( - list(:BULLET, - item(nil, - para("outer"), - list(:BULLET, - item(nil, para("inner")))))) - - assert_equal expected, doc - end - - def test_parse_list_bullet_nest_continue - doc = parse <<-MD -* outer - * inner - continue inner -* outer 2 - MD - - expected = doc( - list(:BULLET, - item(nil, - para("outer"), - list(:BULLET, - item(nil, - para("inner\n continue inner")))), - item(nil, - para("outer 2")))) - - assert_equal expected, doc - end - - def test_parse_list_number - doc = parse <<-MD -1. one -1. two - MD - - expected = doc( - list(:NUMBER, - item(nil, para("one")), - item(nil, para("two")))) - - assert_equal expected, doc - end - - def test_parse_list_number_continue - doc = parse <<-MD -1. one - -1. two - MD - - expected = doc( - list(:NUMBER, - item(nil, para("one")), - item(nil, para("two")))) - - assert_equal expected, doc - end - - def test_parse_note - @parser.notes = true - - doc = parse <<-MD -Some text.[^1] - -[^1]: With a footnote - MD - - expected = doc( - para("Some text.{*1}[rdoc-label:foottext-1:footmark-1]"), - @RM::Rule.new(1), - para("{^1}[rdoc-label:footmark-1:foottext-1] With a footnote")) - - assert_equal expected, doc - end - - def test_parse_note_indent - @parser.notes = true - - doc = parse <<-MD -Some text.[^1] - -[^1]: With a footnote - - more - MD - - expected = doc( - para("Some text.{*1}[rdoc-label:foottext-1:footmark-1]"), - rule(1), - para("{^1}[rdoc-label:footmark-1:foottext-1] With a footnote\n\nmore")) - - assert_equal expected, doc - end - - def test_parse_note_inline - @parser.notes = true - - doc = parse <<-MD -Some text. ^[With a footnote] - MD - - expected = doc( - para("Some text. {*1}[rdoc-label:foottext-1:footmark-1]"), - @RM::Rule.new(1), - para("{^1}[rdoc-label:footmark-1:foottext-1] With a footnote")) - - assert_equal expected, doc - end - - def test_parse_note_no_notes - @parser.notes = false - - assert_raise RDoc::Markdown::ParseError do - parse "Some text.[^1]" - end - end - - def test_parse_note_multiple - @parser.notes = true - - doc = parse <<-MD -Some text[^1] -with inline notes^[like this] -and an extra note.[^2] - -[^1]: With a footnote -[^2]: Which should be numbered correctly - MD - - expected = doc( - para("Some text{*1}[rdoc-label:foottext-1:footmark-1]\n" + - "with inline notes{*2}[rdoc-label:foottext-2:footmark-2]\n" + - "and an extra note.{*3}[rdoc-label:foottext-3:footmark-3]"), - - rule(1), - - para("{^1}[rdoc-label:footmark-1:foottext-1] With a footnote"), - para("{^2}[rdoc-label:footmark-2:foottext-2] like this"), - para("{^3}[rdoc-label:footmark-3:foottext-3] " + - "Which should be numbered correctly")) - - assert_equal expected, doc - end - - def test_parse_paragraph - doc = parse "it worked\n" - - expected = doc(para("it worked")) - - assert_equal expected, doc - end - - def test_parse_paragraph_break_on_newline - @parser.break_on_newline = true - - doc = parse "one\ntwo\n" - - expected = doc(para("one", hard_break, "two")) - - assert_equal expected, doc - - doc = parse "one \ntwo\nthree\n" - - expected = doc(para("one", hard_break, "two", hard_break, "three")) - - assert_equal expected, doc - end - - def test_parse_paragraph_stars - doc = parse "it worked ****\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it worked ****")) - - assert_equal expected, doc - end - - def test_parse_paragraph_html - @parser.html = true - - doc = parse "<address>Links here</address>" - - expected = doc(raw("<address>Links here</address>")) - - assert_equal expected, doc - end - - def test_parse_paragraph_html_no_html - @parser.html = false - - doc = parse "<address>Links here</address>" - - expected = doc() - - assert_equal expected, doc - end - - def test_parse_paragraph_indent_one - doc = parse <<-MD - text - MD - - expected = doc(para("text")) - - assert_equal expected, doc - end - - def test_parse_paragraph_indent_two - doc = parse <<-MD - text - MD - - expected = doc(para("text")) - - assert_equal expected, doc - end - - def test_parse_paragraph_indent_three - doc = parse <<-MD - text - MD - - expected = doc(para("text")) - - assert_equal expected, doc - end - - def test_parse_paragraph_multiline - doc = parse "one\ntwo" - - expected = doc(para("one\ntwo")) - - assert_equal expected, doc - end - - def test_parse_paragraph_two - doc = parse "one\n\ntwo" - - expected = @RM::Document.new( - @RM::Paragraph.new("one"), - @RM::Paragraph.new("two")) - - assert_equal expected, doc - end - - def test_parse_plain - doc = parse "it worked" - - expected = @RM::Document.new( - @RM::Paragraph.new("it worked")) - - assert_equal expected, doc - end - - def test_parse_reference_link_embedded_bracket - doc = parse "With [embedded [brackets]] [b].\n\n[b]: /url/\n" - - expected = - doc( - para("With {embedded [brackets]}[/url/].")) - - assert_equal expected, doc - end - - def test_parse_rule_dash - doc = parse "- - -\n\n" - - expected = @RM::Document.new(@RM::Rule.new(1)) - - assert_equal expected, doc - end - - def test_parse_rule_underscore - doc = parse "_ _ _\n\n" - - expected = @RM::Document.new(@RM::Rule.new(1)) - - assert_equal expected, doc - end - - def test_parse_rule_star - doc = parse "* * *\n\n" - - expected = @RM::Document.new(@RM::Rule.new(1)) - - assert_equal expected, doc - end - - def test_parse_strong_star - doc = parse "it **works**\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it *works*")) - - assert_equal expected, doc - end - - def test_parse_strong_underscore - doc = parse "it __works__\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it *works*")) - - assert_equal expected, doc - end - - def test_parse_strong_emphasis_star - doc = parse "it ***works***\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it <b>_works_</b>")) - - assert_equal expected, doc - end - - def test_parse_strong_emphasis_underscore - doc = parse "it ___works___\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it <b>_works_</b>")) - - assert_equal expected, doc - end - - def test_parse_strike_tilde - doc = parse "it ~~works~~\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it ~works~")) - - assert_equal expected, doc - end - - def test_parse_strike_words_tilde - doc = parse "it ~~works fine~~\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it <s>works fine</s>")) - - assert_equal expected, doc - end - - def test_parse_strike_tilde_no - @parser.strike = false - - doc = parse "it ~~works fine~~\n" - - expected = @RM::Document.new( - @RM::Paragraph.new("it ~~works fine~~")) - - assert_equal expected, doc - end - - def test_parse_style - @parser.css = true - - doc = parse "<style>h1 { color: red }</style>\n" - - expected = doc( - @RM::Raw.new("<style>h1 { color: red }</style>")) - - assert_equal expected, doc - end - - def test_parse_style_disabled - doc = parse "<style>h1 { color: red }</style>\n" - - expected = doc() - - assert_equal expected, doc - end - - def test_parse_verbatim - doc = parse <<-MD - text - MD - - expected = doc(verb("text\n")) - - assert_equal expected, doc - end - - def test_parse_verbatim_eof - doc = parse " text" - - expected = doc(verb("text\n")) - - assert_equal expected, doc - end - - def test_strong - assert_equal '*word*', @parser.strong('word') - assert_equal '<b>two words</b>', @parser.strong('two words') - assert_equal '<b>_emphasis_</b>', @parser.strong('_emphasis_') - end - - def test_code_fence_with_unintended_array - doc = parse '```<ruby>```' - - expected = doc(verb('<ruby>')) - - assert_equal expected, doc - end - - def test_gfm_table - doc = parse <<~MD - | | |compare-ruby|built-ruby| - |------|:----------------|-----------:|---------:| - |test | 1 | 11.618M| 10.757M| - | | | 1.08x| -| - |test | 10 | 1.849M| 1.723M| - | | | 1.07x| -| - MD - - head = ["", "", "compare-ruby", "built-ruby"] - align = [nil, :left, :right, :right] - body = [ - ["test", "1", "11.618M", "10.757M"], - ["", "", "1.08x", "-"], - ["test", "10", "1.849M", "1.723M"], - ["", "", "1.07x", "-"], - ] - expected = doc(@RM::Table.new(head, align, body)) - - assert_equal expected, doc - end - - def test_gfm_table_2 - doc = parse <<~'MD' - | Cmd | Returns | Meaning - ----- | :-----: | ------- - |"b" | boolean | True if file1 is a block device - "c" | boolean | True if file1 is a character device - |"\|" | boolean | escaped bar \| test - MD - - head = %w[Cmd Returns Meaning] - align = [nil, :center, nil] - body = [ - ['"b"', 'boolean', 'True if file1 is a block device'], - ['"c"', 'boolean', 'True if file1 is a character device'], - ['"|"', 'boolean', 'escaped bar | test'], - ] - expected = doc(@RM::Table.new(head, align, body)) - - assert_equal expected, doc - end - - def parse text - @parser.parse text - end - -end diff --git a/test/rdoc/test_rdoc_markdown_test.rb b/test/rdoc/test_rdoc_markdown_test.rb deleted file mode 100644 index 193d648253..0000000000 --- a/test/rdoc/test_rdoc_markdown_test.rb +++ /dev/null @@ -1,1883 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' -require 'pp' - -require_relative '../../lib/rdoc' -require_relative '../../lib/rdoc/markdown' - -class TestRDocMarkdownTest < RDoc::TestCase - - MARKDOWN_TEST_PATH = File.expand_path '../MarkdownTest_1.0.3/', __FILE__ - - def setup - super - - @parser = RDoc::Markdown.new - end - - def test_amps_and_angle_encoding - input = File.read "#{MARKDOWN_TEST_PATH}/Amps and angle encoding.text" - - doc = @parser.parse input - - expected = - doc( - para("AT&T has an ampersand in their name."), - para("AT&T is another way to write it."), - para("This & that."), - para("4 < 5."), - para("6 > 5."), - para("Here's a {link}[http://example.com/?foo=1&bar=2] with " + - "an ampersand in the URL."), - para("Here's a link with an amersand in the link text: " + - "{AT&T}[http://att.com/]."), - para("Here's an inline {link}[/script?foo=1&bar=2]."), - para("Here's an inline {link}[/script?foo=1&bar=2].")) - - assert_equal expected, doc - end - - def test_auto_links - input = File.read "#{MARKDOWN_TEST_PATH}/Auto links.text" - - doc = @parser.parse input - - # TODO verify rdoc auto-links too - expected = - doc( - para("Link: http://example.com/."), - para("With an ampersand: http://example.com/?foo=1&bar=2"), - list(:BULLET, - item(nil, para("In a list?")), - item(nil, para("http://example.com/")), - item(nil, para("It should."))), - block( - para("Blockquoted: http://example.com/")), - para("Auto-links should not occur here: " + - "<code><http://example.com/></code>"), - verb("or here: <http://example.com/>\n")) - - assert_equal expected, doc - end - - def test_backslash_escapes - input = File.read "#{MARKDOWN_TEST_PATH}/Backslash escapes.text" - - doc = @parser.parse input - - expected = - doc( - para("These should all get escaped:"), - - para("Backslash: \\"), - para("Backtick: `"), - para("Asterisk: *"), - para("Underscore: _"), - para("Left brace: {"), - para("Right brace: }"), - para("Left bracket: ["), - para("Right bracket: ]"), - para("Left paren: ("), - para("Right paren: )"), - para("Greater-than: >"), - para("Hash: #"), - para("Period: ."), - para("Bang: !"), - para("Plus: +"), - para("Minus: -"), - - para("These should not, because they occur within a code block:"), - - verb("Backslash: \\\\\n", - "\n", - "Backtick: \\`\n", - "\n", - "Asterisk: \\*\n", - "\n", - "Underscore: \\_\n", - "\n", - "Left brace: \\{\n", - "\n", - "Right brace: \\}\n", - "\n", - "Left bracket: \\[\n", - "\n", - "Right bracket: \\]\n", - "\n", - "Left paren: \\(\n", - "\n", - "Right paren: \\)\n", - "\n", - "Greater-than: \\>\n", - "\n", - "Hash: \\#\n", - "\n", - "Period: \\.\n", - "\n", - "Bang: \\!\n", - "\n", - "Plus: \\+\n", - "\n", - "Minus: \\-\n"), - - para("Nor should these, which occur in code spans:"), - - para("Backslash: <code>\\\\</code>"), - para("Backtick: <code>\\`</code>"), - para("Asterisk: <code>\\*</code>"), - para("Underscore: <code>\\_</code>"), - para("Left brace: <code>\\{</code>"), - para("Right brace: <code>\\}</code>"), - para("Left bracket: <code>\\[</code>"), - para("Right bracket: <code>\\]</code>"), - para("Left paren: <code>\\(</code>"), - para("Right paren: <code>\\)</code>"), - para("Greater-than: <code>\\></code>"), - para("Hash: <code>\\#</code>"), - para("Period: <code>\\.</code>"), - para("Bang: <code>\\!</code>"), - para("Plus: <code>\\+</code>"), - para("Minus: <code>\\-</code>"), - - para("These should get escaped, even though they're matching pairs for\n" + - "other Markdown constructs:"), - - para("\*asterisks\*"), - para("\_underscores\_"), - para("`backticks`"), - - para("This is a code span with a literal backslash-backtick " + - "sequence: <code>\\`</code>"), - - para("This is a tag with unescaped backticks " + - "<span attr='`ticks`'>bar</span>."), - - para("This is a tag with backslashes " + - "<span attr='\\\\backslashes\\\\'>bar</span>.")) - - assert_equal expected, doc - end - - def test_blockquotes_with_code_blocks - input = File.read "#{MARKDOWN_TEST_PATH}/Blockquotes with code blocks.text" - - doc = @parser.parse input - - expected = - doc( - block( - para("Example:"), - verb("sub status {\n", - " print \"working\";\n", - "}\n"), - para("Or:"), - verb("sub status {\n", - " return \"working\";\n", - "}\n"))) - - assert_equal expected, doc - end - - def test_code_blocks - input = File.read "#{MARKDOWN_TEST_PATH}/Code Blocks.text" - - doc = @parser.parse input - - expected = - doc( - verb("code block on the first line\n"), - para("Regular text."), - - verb("code block indented by spaces\n"), - para("Regular text."), - - verb("the lines in this block \n", - "all contain trailing spaces \n"), - para("Regular Text."), - - verb("code block on the last line\n")) - - assert_equal expected, doc - end - - def test_code_spans - input = File.read "#{MARKDOWN_TEST_PATH}/Code Spans.text" - - doc = @parser.parse input - - expected = doc( - para("<code><test a=\"</code> content of attribute <code>\"></code>"), - para("Fix for backticks within HTML tag: " + - "<span attr='`ticks`'>like this</span>"), - para("Here's how you put <code>`backticks`</code> in a code span.")) - - assert_equal expected, doc - end - - def test_hard_wrapped_paragraphs_with_list_like_lines - input = File.read "#{MARKDOWN_TEST_PATH}/Hard-wrapped paragraphs with list-like lines.text" - - doc = @parser.parse input - - expected = - doc( - para("In Markdown 1.0.0 and earlier. Version\n" + - "8. This line turns into a list item.\n" + - "Because a hard-wrapped line in the\n" + - "middle of a paragraph looked like a\n" + - "list item."), - para("Here's one with a bullet.\n" + - "* criminey.")) - - assert_equal expected, doc - end - - def test_horizontal_rules - input = File.read "#{MARKDOWN_TEST_PATH}/Horizontal rules.text" - - doc = @parser.parse input - - expected = - doc( - para("Dashes:"), - - rule(1), - rule(1), - rule(1), - rule(1), - verb("---\n"), - - rule(1), - rule(1), - rule(1), - rule(1), - verb("- - -\n"), - - para("Asterisks:"), - - rule(1), - rule(1), - rule(1), - rule(1), - verb("***\n"), - - rule(1), - rule(1), - rule(1), - rule(1), - verb("* * *\n"), - - para("Underscores:"), - - rule(1), - rule(1), - rule(1), - rule(1), - verb("___\n"), - - rule(1), - rule(1), - rule(1), - rule(1), - verb("_ _ _\n")) - - assert_equal expected, doc - end - - def test_inline_html_advanced - input = File.read "#{MARKDOWN_TEST_PATH}/Inline HTML (Advanced).text" - - @parser.html = true - - doc = @parser.parse input - - expected = - doc( - para("Simple block on one line:"), - raw("<div>foo</div>"), - para("And nested without indentation:"), - raw(<<-RAW.chomp)) -<div> -<div> -<div> -foo -</div> -<div style=">"/> -</div> -<div>bar</div> -</div> - RAW - - assert_equal expected, doc - end - - def test_inline_html_simple - input = File.read "#{MARKDOWN_TEST_PATH}/Inline HTML (Simple).text" - - @parser.html = true - - doc = @parser.parse input - - expected = - doc( - para("Here's a simple block:"), - raw("<div>\n\tfoo\n</div>"), - - para("This should be a code block, though:"), - verb("<div>\n", - "\tfoo\n", - "</div>\n"), - - para("As should this:"), - verb("<div>foo</div>\n"), - - para("Now, nested:"), - raw("<div>\n\t<div>\n\t\t<div>\n\t\t\tfoo\n" + - "\t\t</div>\n\t</div>\n</div>"), - - para("This should just be an HTML comment:"), - raw("<!-- Comment -->"), - - para("Multiline:"), - raw("<!--\nBlah\nBlah\n-->"), - - para("Code block:"), - verb("<!-- Comment -->\n"), - - para("Just plain comment, with trailing spaces on the line:"), - raw("<!-- foo -->"), - - para("Code:"), - verb("<hr />\n"), - - para("Hr's:"), - raw("<hr>"), - raw("<hr/>"), - raw("<hr />"), - - raw("<hr>"), - raw("<hr/>"), - raw("<hr />"), - - raw("<hr class=\"foo\" id=\"bar\" />"), - raw("<hr class=\"foo\" id=\"bar\"/>"), - raw("<hr class=\"foo\" id=\"bar\" >")) - - assert_equal expected, doc - end - - def test_inline_html_comments - input = File.read "#{MARKDOWN_TEST_PATH}/Inline HTML comments.text" - - doc = @parser.parse input - - expected = - doc( - para("Paragraph one."), - - raw("<!-- This is a simple comment -->"), - - raw("<!--\n\tThis is another comment.\n-->"), - - para("Paragraph two."), - - raw("<!-- one comment block -- -- with two comments -->"), - - para("The end.")) - - assert_equal expected, doc - end - - def test_links_inline_style - input = File.read "#{MARKDOWN_TEST_PATH}/Links, inline style.text" - - doc = @parser.parse input - - expected = - doc( - para("Just a {URL}[/url/]."), - para("{URL and title}[/url/]."), - para("{URL and title}[/url/]."), - para("{URL and title}[/url/]."), - para("{URL and title}[/url/]."), - para("{Empty}[].")) - - assert_equal expected, doc - end - - def test_links_reference_style - input = File.read "#{MARKDOWN_TEST_PATH}/Links, reference style.text" - - doc = @parser.parse input - - expected = - doc( - para("Foo {bar}[/url/]."), - para("Foo {bar}[/url/]."), - para("Foo {bar}[/url/]."), - - para("With {embedded [brackets]}[/url/]."), - - para("Indented {once}[/url]."), - para("Indented {twice}[/url]."), - para("Indented {thrice}[/url]."), - para("Indented [four][] times."), - - verb("[four]: /url\n"), - - rule(1), - - para("{this}[foo] should work"), - para("So should {this}[foo]."), - para("And {this}[foo]."), - para("And {this}[foo]."), - para("And {this}[foo]."), - - para("But not [that] []."), - para("Nor [that][]."), - para("Nor [that]."), - - para("[Something in brackets like {this}[foo] should work]"), - para("[Same with {this}[foo].]"), - - para("In this case, {this}[/somethingelse/] points to something else."), - para("Backslashing should suppress [this] and [this]."), - - rule(1), - - para("Here's one where the {link breaks}[/url/] across lines."), - para("Here's another where the {link breaks}[/url/] across lines, " + - "but with a line-ending space.")) - - assert_equal expected, doc - end - - def test_links_shortcut_references - input = File.read "#{MARKDOWN_TEST_PATH}/Links, shortcut references.text" - - doc = @parser.parse input - - expected = - doc( - para("This is the {simple case}[/simple]."), - para("This one has a {line break}[/foo]."), - para("This one has a {line break}[/foo] with a line-ending space."), - para("{this}[/that] and the {other}[/other]")) - - assert_equal expected, doc - end - - def test_literal_quotes_in_titles - input = File.read "#{MARKDOWN_TEST_PATH}/Literal quotes in titles.text" - - doc = @parser.parse input - - # TODO support title attribute - expected = - doc( - para("Foo {bar}[/url/]."), - para("Foo {bar}[/url/].")) - - assert_equal expected, doc - end - - def test_markdown_documentation_basics - input = File.read "#{MARKDOWN_TEST_PATH}/Markdown Documentation - Basics.text" - - doc = @parser.parse input - - expected = - doc( - head(1, "Markdown: Basics"), - - raw(<<-RAW.chomp), -<ul id="ProjectSubmenu"> - <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li> - <li><a class="selected" title="Markdown Basics">Basics</a></li> - <li><a href="/projects/markdown/syntax" title="Markdown Syntax Documentation">Syntax</a></li> - <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li> - <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li> -</ul> - RAW - - head(2, "Getting the Gist of Markdown's Formatting Syntax"), - - para("This page offers a brief overview of what it's like to use Markdown.\n" + - "The {syntax page}[/projects/markdown/syntax] provides complete, detailed documentation for\n" + - "every feature, but Markdown should be very easy to pick up simply by\n" + - "looking at a few examples of it in action. The examples on this page\n" + - "are written in a before/after style, showing example syntax and the\n" + - "HTML output produced by Markdown."), - - para("It's also helpful to simply try Markdown out; the {Dingus}[/projects/markdown/dingus] is a\n" + - "web application that allows you type your own Markdown-formatted text\n" + - "and translate it to XHTML."), - - para("<b>Note:</b> This document is itself written using Markdown; you\n" + - "can {see the source for it by adding '.text' to the URL}[/projects/markdown/basics.text]."), - - head(2, "Paragraphs, Headers, Blockquotes"), - - para("A paragraph is simply one or more consecutive lines of text, separated\n" + - "by one or more blank lines. (A blank line is any line that looks like a\n" + - "blank line -- a line containing nothing spaces or tabs is considered\n" + - "blank.) Normal paragraphs should not be intended with spaces or tabs."), - - para("Markdown offers two styles of headers: _Setext_ and _atx_.\n" + - "Setext-style headers for <code><h1></code> and <code><h2></code> are created by\n" + - "\"underlining\" with equal signs (<code>=</code>) and hyphens (<code>-</code>), respectively.\n" + - "To create an atx-style header, you put 1-6 hash marks (<code>#</code>) at the\n" + - "beginning of the line -- the number of hashes equals the resulting\n" + - "HTML header level."), - - para("Blockquotes are indicated using email-style '<code>></code>' angle brackets."), - - para("Markdown:"), - - verb("A First Level Header\n", - "====================\n", - "\n", - "A Second Level Header\n", - "---------------------\n", - "\n", - "Now is the time for all good men to come to\n", - "the aid of their country. This is just a\n", - "regular paragraph.\n", - "\n", - "The quick brown fox jumped over the lazy\n", - "dog's back.\n", - "\n", - "### Header 3\n", - "\n", - "> This is a blockquote.\n", - "> \n", - "> This is the second paragraph in the blockquote.\n", - ">\n", - "> ## This is an H2 in a blockquote\n"), - - para("Output:"), - - verb("<h1>A First Level Header</h1>\n", - "\n", - "<h2>A Second Level Header</h2>\n", - "\n", - "<p>Now is the time for all good men to come to\n", - "the aid of their country. This is just a\n", - "regular paragraph.</p>\n", - "\n", - "<p>The quick brown fox jumped over the lazy\n", - "dog's back.</p>\n", - "\n", - "<h3>Header 3</h3>\n", - "\n", - "<blockquote>\n", - " <p>This is a blockquote.</p>\n", - "\n", - " <p>This is the second paragraph in the blockquote.</p>\n", - "\n", - " <h2>This is an H2 in a blockquote</h2>\n", - "</blockquote>\n"), - - head(3, "Phrase Emphasis"), - para("Markdown uses asterisks and underscores to indicate spans of emphasis."), - - para("Markdown:"), - - verb("Some of these words *are emphasized*.\n", - "Some of these words _are emphasized also_.\n", - "\n", - "Use two asterisks for **strong emphasis**.\n", - "Or, if you prefer, __use two underscores instead__.\n"), - - para("Output:"), - - verb("<p>Some of these words <em>are emphasized</em>.\n", - "Some of these words <em>are emphasized also</em>.</p>\n", - "\n", - "<p>Use two asterisks for <strong>strong emphasis</strong>.\n", - "Or, if you prefer, <strong>use two underscores instead</strong>.</p>\n"), - - head(2, "Lists"), - - para("Unordered (bulleted) lists use asterisks, pluses, and hyphens (<code>*</code>,\n" + - "<code>+</code>, and <code>-</code>) as list markers. These three markers are\n" + - "interchangeable; this:"), - - verb("* Candy.\n", - "* Gum.\n", - "* Booze.\n"), - - para("this:"), - - verb("+ Candy.\n", - "+ Gum.\n", - "+ Booze.\n"), - - para("and this:"), - - verb("- Candy.\n", - "- Gum.\n", - "- Booze.\n"), - - para("all produce the same output:"), - - verb("<ul>\n", - "<li>Candy.</li>\n", - "<li>Gum.</li>\n", - "<li>Booze.</li>\n", - "</ul>\n"), - - para("Ordered (numbered) lists use regular numbers, followed by periods, as\n" + - "list markers:"), - - verb("1. Red\n", - "2. Green\n", - "3. Blue\n"), - - para("Output:"), - - verb("<ol>\n", - "<li>Red</li>\n", - "<li>Green</li>\n", - "<li>Blue</li>\n", - "</ol>\n"), - - para("If you put blank lines between items, you'll get <code><p></code> tags for the\n" + - "list item text. You can create multi-paragraph list items by indenting\n" + - "the paragraphs by 4 spaces or 1 tab:"), - - verb("* A list item.\n", - "\n", - " With multiple paragraphs.\n", - "\n", - "* Another item in the list.\n"), - - para("Output:"), - - verb("<ul>\n", - "<li><p>A list item.</p>\n", - "<p>With multiple paragraphs.</p></li>\n", - "<li><p>Another item in the list.</p></li>\n", - "</ul>\n"), - - head(3, "Links"), - - para("Markdown supports two styles for creating links: _inline_ and\n" + - "_reference_. With both styles, you use square brackets to delimit the\n" + - "text you want to turn into a link."), - - para("Inline-style links use parentheses immediately after the link text.\n" + - "For example:"), - - verb("This is an [example link](http://example.com/).\n"), - - para("Output:"), - - verb("<p>This is an <a href=\"http://example.com/\">\n", - "example link</a>.</p>\n"), - - para("Optionally, you may include a title attribute in the parentheses:"), - - verb("This is an [example link](http://example.com/ \"With a Title\").\n"), - - para("Output:"), - - verb("<p>This is an <a href=\"http://example.com/\" title=\"With a Title\">\n", - "example link</a>.</p>\n"), - - para("Reference-style links allow you to refer to your links by names, which\n" + - "you define elsewhere in your document:"), - - verb("I get 10 times more traffic from [Google][1] than from\n", - "[Yahoo][2] or [MSN][3].\n", - "\n", - "[1]: http://google.com/ \"Google\"\n", - "[2]: http://search.yahoo.com/ \"Yahoo Search\"\n", - "[3]: http://search.msn.com/ \"MSN Search\"\n"), - - para("Output:"), - - verb("<p>I get 10 times more traffic from <a href=\"http://google.com/\"\n", - "title=\"Google\">Google</a> than from <a href=\"http://search.yahoo.com/\"\n", - "title=\"Yahoo Search\">Yahoo</a> or <a href=\"http://search.msn.com/\"\n", - "title=\"MSN Search\">MSN</a>.</p>\n"), - - para("The title attribute is optional. Link names may contain letters,\n" + - "numbers and spaces, but are _not_ case sensitive:"), - - verb("I start my morning with a cup of coffee and\n", - "[The New York Times][NY Times].\n", - "\n", - "[ny times]: http://www.nytimes.com/\n"), - - para("Output:"), - - verb("<p>I start my morning with a cup of coffee and\n", - "<a href=\"http://www.nytimes.com/\">The New York Times</a>.</p>\n"), - - head(3, "Images"), - - para("Image syntax is very much like link syntax."), - - para("Inline (titles are optional):"), - - verb("![alt text](/path/to/img.jpg \"Title\")\n"), - - para("Reference-style:"), - - verb("![alt text][id]\n", - "\n", - "[id]: /path/to/img.jpg \"Title\"\n"), - - para("Both of the above examples produce the same output:"), - - verb("<img src=\"/path/to/img.jpg\" alt=\"alt text\" title=\"Title\" />\n"), - - head(3, "Code"), - - para("In a regular paragraph, you can create code span by wrapping text in\n" + - "backtick quotes. Any ampersands (<code>&</code>) and angle brackets (<code><</code> or\n" + - "<code>></code>) will automatically be translated into HTML entities. This makes\n" + - "it easy to use Markdown to write about HTML example code:"), - - verb( - "I strongly recommend against using any `<blink>` tags.\n", - "\n", - "I wish SmartyPants used named entities like `—`\n", - "instead of decimal-encoded entities like `—`.\n"), - - para("Output:"), - - verb("<p>I strongly recommend against using any\n", - "<code><blink></code> tags.</p>\n", - "\n", - "<p>I wish SmartyPants used named entities like\n", - "<code>&mdash;</code> instead of decimal-encoded\n", - "entities like <code>&#8212;</code>.</p>\n"), - - para("To specify an entire block of pre-formatted code, indent every line of\n" + - "the block by 4 spaces or 1 tab. Just like with code spans, <code>&</code>, <code><</code>,\n" + - "and <code>></code> characters will be escaped automatically."), - - para("Markdown:"), - - verb("If you want your page to validate under XHTML 1.0 Strict,\n", - "you've got to put paragraph tags in your blockquotes:\n", - "\n", - " <blockquote>\n", - " <p>For example.</p>\n", - " </blockquote>\n"), - - para("Output:"), - - verb("<p>If you want your page to validate under XHTML 1.0 Strict,\n", - "you've got to put paragraph tags in your blockquotes:</p>\n", - "\n", - "<pre><code><blockquote>\n", - " <p>For example.</p>\n", - "</blockquote>\n", - "</code></pre>\n")) - - assert_equal expected, doc - end - - def test_markdown_documentation_syntax - input = File.read "#{MARKDOWN_TEST_PATH}/Markdown Documentation - Syntax.text" - - doc = @parser.parse input - - expected = - doc( - head(1, "Markdown: Syntax"), - - raw(<<-RAW.chomp), -<ul id="ProjectSubmenu"> - <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li> - <li><a href="/projects/markdown/basics" title="Markdown Basics">Basics</a></li> - <li><a class="selected" title="Markdown Syntax Documentation">Syntax</a></li> - <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li> - <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li> -</ul> - RAW - - list(:BULLET, - item(nil, - para("{Overview}[#overview]"), - list(:BULLET, - item(nil, - para("{Philosophy}[#philosophy]")), - item(nil, - para("{Inline HTML}[#html]")), - item(nil, - para("{Automatic Escaping for Special Characters}[#autoescape]")))), - item(nil, - para("{Block Elements}[#block]"), - list(:BULLET, - item(nil, - para("{Paragraphs and Line Breaks}[#p]")), - item(nil, - para("{Headers}[#header]")), - item(nil, - para("{Blockquotes}[#blockquote]")), - item(nil, - para("{Lists}[#list]")), - item(nil, - para("{Code Blocks}[#precode]")), - item(nil, - para("{Horizontal Rules}[#hr]")))), - item(nil, - para("{Span Elements}[#span]"), - list(:BULLET, - item(nil, - para("{Links}[#link]")), - item(nil, - para("{Emphasis}[#em]")), - item(nil, - para("{Code}[#code]")), - item(nil, - para("{Images}[#img]")))), - item(nil, - para("{Miscellaneous}[#misc]"), - list(:BULLET, - item(nil, - para("{Backslash Escapes}[#backslash]")), - item(nil, - para("{Automatic Links}[#autolink]"))))), - - para("<b>Note:</b> This document is itself written using Markdown; you\n" + - "can {see the source for it by adding '.text' to the URL}[/projects/markdown/syntax.text]."), - - rule(1), - - raw("<h2 id=\"overview\">Overview</h2>"), - - raw("<h3 id=\"philosophy\">Philosophy</h3>"), - - para("Markdown is intended to be as easy-to-read and easy-to-write as is feasible."), - - para("Readability, however, is emphasized above all else. A Markdown-formatted\n" + - "document should be publishable as-is, as plain text, without looking\n" + - "like it's been marked up with tags or formatting instructions. While\n" + - "Markdown's syntax has been influenced by several existing text-to-HTML\n" + - "filters -- including {Setext}[http://docutils.sourceforge.net/mirror/setext.html], {atx}[http://www.aaronsw.com/2002/atx/], {Textile}[http://textism.com/tools/textile/], {reStructuredText}[http://docutils.sourceforge.net/rst.html],\n" + - "{Grutatext}[http://www.triptico.com/software/grutatxt.html], and {EtText}[http://ettext.taint.org/doc/] -- the single biggest source of\n" + - "inspiration for Markdown's syntax is the format of plain text email."), - - para("To this end, Markdown's syntax is comprised entirely of punctuation\n" + - "characters, which punctuation characters have been carefully chosen so\n" + - "as to look like what they mean. E.g., asterisks around a word actually\n" + - "look like \*emphasis\*. Markdown lists look like, well, lists. Even\n" + - "blockquotes look like quoted passages of text, assuming you've ever\n" + - "used email."), - - raw("<h3 id=\"html\">Inline HTML</h3>"), - - para("Markdown's syntax is intended for one purpose: to be used as a\n" + - "format for _writing_ for the web."), - - para("Markdown is not a replacement for HTML, or even close to it. Its\n" + - "syntax is very small, corresponding only to a very small subset of\n" + - "HTML tags. The idea is _not_ to create a syntax that makes it easier\n" + - "to insert HTML tags. In my opinion, HTML tags are already easy to\n" + - "insert. The idea for Markdown is to make it easy to read, write, and\n" + - "edit prose. HTML is a _publishing_ format; Markdown is a _writing_\n" + - "format. Thus, Markdown's formatting syntax only addresses issues that\n" + - "can be conveyed in plain text."), - - para("For any markup that is not covered by Markdown's syntax, you simply\n" + - "use HTML itself. There's no need to preface it or delimit it to\n" + - "indicate that you're switching from Markdown to HTML; you just use\n" + - "the tags."), - - para("The only restrictions are that block-level HTML elements -- e.g. <code><div></code>,\n" + - "<code><table></code>, <code><pre></code>, <code><p></code>, etc. -- must be separated from surrounding\n" + - "content by blank lines, and the start and end tags of the block should\n" + - "not be indented with tabs or spaces. Markdown is smart enough not\n" + - "to add extra (unwanted) <code><p></code> tags around HTML block-level tags."), - - para("For example, to add an HTML table to a Markdown article:"), - - verb("This is a regular paragraph.\n", - "\n", - "<table>\n", - " <tr>\n", - " <td>Foo</td>\n", - " </tr>\n", - "</table>\n", - "\n", - "This is another regular paragraph.\n"), - - para("Note that Markdown formatting syntax is not processed within block-level\n" + - "HTML tags. E.g., you can't use Markdown-style <code>*emphasis*</code> inside an\n" + - "HTML block."), - - para("Span-level HTML tags -- e.g. <code><span></code>, <code><cite></code>, or <code><del></code> -- can be\n" + - "used anywhere in a Markdown paragraph, list item, or header. If you\n" + - "want, you can even use HTML tags instead of Markdown formatting; e.g. if\n" + - "you'd prefer to use HTML <code><a></code> or <code><img></code> tags instead of Markdown's\n" + - "link or image syntax, go right ahead."), - - para("Unlike block-level HTML tags, Markdown syntax _is_ processed within\n" + - "span-level tags."), - - raw("<h3 id=\"autoescape\">Automatic Escaping for Special Characters</h3>"), - - para("In HTML, there are two characters that demand special treatment: <code><</code>\n" + - "and <code>&</code>. Left angle brackets are used to start tags; ampersands are\n" + - "used to denote HTML entities. If you want to use them as literal\n" + - "characters, you must escape them as entities, e.g. <code><</code>, and\n" + - "<code>&</code>."), - - para("Ampersands in particular are bedeviling for web writers. If you want to\n" + - "write about 'AT&T', you need to write '<code>AT&T</code>'. You even need to\n" + - "escape ampersands within URLs. Thus, if you want to link to:"), - - verb("http://images.google.com/images?num=30&q=larry+bird\n"), - - para("you need to encode the URL as:"), - - verb("http://images.google.com/images?num=30&q=larry+bird\n"), - - para("in your anchor tag <code>href</code> attribute. Needless to say, this is easy to\n" + - "forget, and is probably the single most common source of HTML validation\n" + - "errors in otherwise well-marked-up web sites."), - - para("Markdown allows you to use these characters naturally, taking care of\n" + - "all the necessary escaping for you. If you use an ampersand as part of\n" + - "an HTML entity, it remains unchanged; otherwise it will be translated\n" + - "into <code>&</code>."), - - para("So, if you want to include a copyright symbol in your article, you can write:"), - - verb("©\n"), - - para("and Markdown will leave it alone. But if you write:"), - - verb("AT&T\n"), - - para("Markdown will translate it to:"), - - verb("AT&T\n"), - - para("Similarly, because Markdown supports {inline HTML}[#html], if you use\n" + - "angle brackets as delimiters for HTML tags, Markdown will treat them as\n" + - "such. But if you write:"), - - verb("4 < 5\n"), - - para("Markdown will translate it to:"), - - verb("4 < 5\n"), - - para("However, inside Markdown code spans and blocks, angle brackets and\n" + - "ampersands are _always_ encoded automatically. This makes it easy to use\n" + - "Markdown to write about HTML code. (As opposed to raw HTML, which is a\n" + - "terrible format for writing about HTML syntax, because every single <code><</code>\n" + - "and <code>&</code> in your example code needs to be escaped.)"), - - rule(1), - - raw("<h2 id=\"block\">Block Elements</h2>"), - - raw("<h3 id=\"p\">Paragraphs and Line Breaks</h3>"), - - para("A paragraph is simply one or more consecutive lines of text, separated\n" + - "by one or more blank lines. (A blank line is any line that looks like a\n" + - "blank line -- a line containing nothing but spaces or tabs is considered\n" + - "blank.) Normal paragraphs should not be intended with spaces or tabs."), - - para("The implication of the \"one or more consecutive lines of text\" rule is\n" + - "that Markdown supports \"hard-wrapped\" text paragraphs. This differs\n" + - "significantly from most other text-to-HTML formatters (including Movable\n" + - "Type's \"Convert Line Breaks\" option) which translate every line break\n" + - "character in a paragraph into a <code><br /></code> tag."), - - para("When you _do_ want to insert a <code><br /></code> break tag using Markdown, you\n" + - "end a line with two or more spaces, then type return."), - - para("Yes, this takes a tad more effort to create a <code><br /></code>, but a simplistic\n" + - "\"every line break is a <code><br /></code>\" rule wouldn't work for Markdown.\n" + - "Markdown's email-style {blockquoting}[#blockquote] and multi-paragraph {list items}[#list]\n" + - "work best -- and look better -- when you format them with hard breaks."), - - raw("<h3 id=\"header\">Headers</h3>"), - - para("Markdown supports two styles of headers, {Setext}[http://docutils.sourceforge.net/mirror/setext.html] and {atx}[http://www.aaronsw.com/2002/atx/]."), - - para("Setext-style headers are \"underlined\" using equal signs (for first-level\n" + - "headers) and dashes (for second-level headers). For example:"), - - verb("This is an H1\n", - "=============\n", - "\n", - "This is an H2\n", - "-------------\n"), - - para("Any number of underlining <code>=</code>'s or <code>-</code>'s will work."), - - para("Atx-style headers use 1-6 hash characters at the start of the line,\n" + - "corresponding to header levels 1-6. For example:"), - - verb("# This is an H1\n", - "\n", - "## This is an H2\n", - "\n", - "###### This is an H6\n"), - - para("Optionally, you may \"close\" atx-style headers. This is purely\n" + - "cosmetic -- you can use this if you think it looks better. The\n" + - "closing hashes don't even need to match the number of hashes\n" + - "used to open the header. (The number of opening hashes\n" + - "determines the header level.) :"), - - verb("# This is an H1 #\n", - "\n", - "## This is an H2 ##\n", - "\n", - "### This is an H3 ######\n"), - - raw("<h3 id=\"blockquote\">Blockquotes</h3>"), - - para( - "Markdown uses email-style <code>></code> characters for blockquoting. If you're\n" + - "familiar with quoting passages of text in an email message, then you\n" + - "know how to create a blockquote in Markdown. It looks best if you hard\n" + - "wrap the text and put a <code>></code> before every line:"), - - verb("> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,\n", - "> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.\n", - "> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.\n", - "> \n", - "> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse\n", - "> id sem consectetuer libero luctus adipiscing.\n"), - - para("Markdown allows you to be lazy and only put the <code>></code> before the first\n" + - "line of a hard-wrapped paragraph:"), - - verb("> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,\n", - "consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.\n", - "Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.\n", - "\n", - "> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse\n", - "id sem consectetuer libero luctus adipiscing.\n"), - - para("Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by\n" + - "adding additional levels of <code>></code>:"), - - verb("> This is the first level of quoting.\n", - ">\n", - "> > This is nested blockquote.\n", - ">\n", - "> Back to the first level.\n"), - - para("Blockquotes can contain other Markdown elements, including headers, lists,\n" + - "and code blocks:"), - - verb("> ## This is a header.\n", - "> \n", - "> 1. This is the first list item.\n", - "> 2. This is the second list item.\n", - "> \n", - "> Here's some example code:\n", - "> \n", - "> return shell_exec(\"echo $input | $markdown_script\");\n"), - - para("Any decent text editor should make email-style quoting easy. For\n" + - "example, with BBEdit, you can make a selection and choose Increase\n" + - "Quote Level from the Text menu."), - - raw("<h3 id=\"list\">Lists</h3>"), - - para("Markdown supports ordered (numbered) and unordered (bulleted) lists."), - - para("Unordered lists use asterisks, pluses, and hyphens -- interchangeably\n" + - "-- as list markers:"), - - verb("* Red\n", - "* Green\n", - "* Blue\n"), - - para("is equivalent to:"), - - verb("+ Red\n", - "+ Green\n", - "+ Blue\n"), - - para("and:"), - - verb("- Red\n", - "- Green\n", - "- Blue\n"), - - para("Ordered lists use numbers followed by periods:"), - - verb("1. Bird\n", - "2. McHale\n", - "3. Parish\n"), - - para("It's important to note that the actual numbers you use to mark the\n" + - "list have no effect on the HTML output Markdown produces. The HTML\n" + - "Markdown produces from the above list is:"), - - verb("<ol>\n", - "<li>Bird</li>\n", - "<li>McHale</li>\n", - "<li>Parish</li>\n", - "</ol>\n"), - - para("If you instead wrote the list in Markdown like this:"), - - verb("1. Bird\n", - "1. McHale\n", - "1. Parish\n"), - - para("or even:"), - - verb("3. Bird\n", - "1. McHale\n", - "8. Parish\n"), - - para("you'd get the exact same HTML output. The point is, if you want to,\n" + - "you can use ordinal numbers in your ordered Markdown lists, so that\n" + - "the numbers in your source match the numbers in your published HTML.\n" + - "But if you want to be lazy, you don't have to."), - - para("If you do use lazy list numbering, however, you should still start the\n" + - "list with the number 1. At some point in the future, Markdown may support\n" + - "starting ordered lists at an arbitrary number."), - - para("List markers typically start at the left margin, but may be indented by\n" + - "up to three spaces. List markers must be followed by one or more spaces\n" + - "or a tab."), - - para("To make lists look nice, you can wrap items with hanging indents:"), - - verb("* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\n", - " Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,\n", - " viverra nec, fringilla in, laoreet vitae, risus.\n", - "* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.\n", - " Suspendisse id sem consectetuer libero luctus adipiscing.\n"), - - para("But if you want to be lazy, you don't have to:"), - - verb("* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\n", - "Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,\n", - "viverra nec, fringilla in, laoreet vitae, risus.\n", - "* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.\n", - "Suspendisse id sem consectetuer libero luctus adipiscing.\n"), - - para("If list items are separated by blank lines, Markdown will wrap the\n" + - "items in <code><p></code> tags in the HTML output. For example, this input:"), - - verb("* Bird\n", - "* Magic\n"), - - para("will turn into:"), - - verb("<ul>\n", - "<li>Bird</li>\n", - "<li>Magic</li>\n", - "</ul>\n"), - - para("But this:"), - - verb("* Bird\n", - "\n", - "* Magic\n"), - - para("will turn into:"), - - verb("<ul>\n", - "<li><p>Bird</p></li>\n", - "<li><p>Magic</p></li>\n", - "</ul>\n"), - - para("List items may consist of multiple paragraphs. Each subsequent\n" + - "paragraph in a list item must be intended by either 4 spaces\n" + - "or one tab:"), - - verb("1. This is a list item with two paragraphs. Lorem ipsum dolor\n", - " sit amet, consectetuer adipiscing elit. Aliquam hendrerit\n", - " mi posuere lectus.\n", - "\n", - " Vestibulum enim wisi, viverra nec, fringilla in, laoreet\n", - " vitae, risus. Donec sit amet nisl. Aliquam semper ipsum\n", - " sit amet velit.\n", - "\n", - "2. Suspendisse id sem consectetuer libero luctus adipiscing.\n"), - - para("It looks nice if you indent every line of the subsequent\n" + - "paragraphs, but here again, Markdown will allow you to be\n" + - "lazy:"), - - verb("* This is a list item with two paragraphs.\n", - "\n", - " This is the second paragraph in the list item. You're\n", - "only required to indent the first line. Lorem ipsum dolor\n", - "sit amet, consectetuer adipiscing elit.\n", - "\n", - "* Another item in the same list.\n"), - - para("To put a blockquote within a list item, the blockquote's <code>></code>\n" + - "delimiters need to be indented:"), - - verb("* A list item with a blockquote:\n", - "\n", - " > This is a blockquote\n", - " > inside a list item.\n"), - - para( - "To put a code block within a list item, the code block needs\n" + - "to be indented _twice_ -- 8 spaces or two tabs:"), - - verb("* A list item with a code block:\n", - "\n", - " <code goes here>\n"), - - para("It's worth noting that it's possible to trigger an ordered list by\n" + - "accident, by writing something like this:"), - - verb("1986. What a great season.\n"), - - para("In other words, a <em>number-period-space</em> sequence at the beginning of a\n" + - "line. To avoid this, you can backslash-escape the period:"), - - verb("1986\\. What a great season.\n"), - - raw("<h3 id=\"precode\">Code Blocks</h3>"), - - para("Pre-formatted code blocks are used for writing about programming or\n" + - "markup source code. Rather than forming normal paragraphs, the lines\n" + - "of a code block are interpreted literally. Markdown wraps a code block\n" + - "in both <code><pre></code> and <code><code></code> tags."), - - para("To produce a code block in Markdown, simply indent every line of the\n" + - "block by at least 4 spaces or 1 tab. For example, given this input:"), - - verb("This is a normal paragraph:\n", - "\n", - " This is a code block.\n"), - - para("Markdown will generate:"), - - verb("<p>This is a normal paragraph:</p>\n", - "\n", - "<pre><code>This is a code block.\n", - "</code></pre>\n"), - - para("One level of indentation -- 4 spaces or 1 tab -- is removed from each\n" + - "line of the code block. For example, this:"), - - verb("Here is an example of AppleScript:\n", - "\n", - " tell application \"Foo\"\n", - " beep\n", - " end tell\n"), - - para("will turn into:"), - - verb("<p>Here is an example of AppleScript:</p>\n", - "\n", - "<pre><code>tell application \"Foo\"\n", - " beep\n", - "end tell\n", - "</code></pre>\n"), - - para("A code block continues until it reaches a line that is not indented\n" + - "(or the end of the article)."), - - para("Within a code block, ampersands (<code>&</code>) and angle brackets (<code><</code> and <code>></code>)\n" + - "are automatically converted into HTML entities. This makes it very\n" + - "easy to include example HTML source code using Markdown -- just paste\n" + - "it and indent it, and Markdown will handle the hassle of encoding the\n" + - "ampersands and angle brackets. For example, this:"), - - verb(" <div class=\"footer\">\n", - " © 2004 Foo Corporation\n", - " </div>\n"), - - para("will turn into:"), - - verb("<pre><code><div class=\"footer\">\n", - " &copy; 2004 Foo Corporation\n", - "</div>\n", - "</code></pre>\n"), - - para("Regular Markdown syntax is not processed within code blocks. E.g.,\n" + - "asterisks are just literal asterisks within a code block. This means\n" + - "it's also easy to use Markdown to write about Markdown's own syntax."), - - raw("<h3 id=\"hr\">Horizontal Rules</h3>"), - - para("You can produce a horizontal rule tag (<code><hr /></code>) by placing three or\n" + - "more hyphens, asterisks, or underscores on a line by themselves. If you\n" + - "wish, you may use spaces between the hyphens or asterisks. Each of the\n" + - "following lines will produce a horizontal rule:"), - - verb("* * *\n", - "\n", - "***\n", - "\n", - "*****\n", - "\n", - "- - -\n", - "\n", - "---------------------------------------\n", - "\n", - "_ _ _\n"), - - rule(1), - - raw("<h2 id=\"span\">Span Elements</h2>"), - - raw("<h3 id=\"link\">Links</h3>"), - - para("Markdown supports two style of links: _inline_ and _reference_."), - - para("In both styles, the link text is delimited by [square brackets]."), - - para("To create an inline link, use a set of regular parentheses immediately\n" + - "after the link text's closing square bracket. Inside the parentheses,\n" + - "put the URL where you want the link to point, along with an _optional_\n" + - "title for the link, surrounded in quotes. For example:"), - - verb("This is [an example](http://example.com/ \"Title\") inline link.\n", - "\n", - "[This link](http://example.net/) has no title attribute.\n"), - - para("Will produce:"), - - verb("<p>This is <a href=\"http://example.com/\" title=\"Title\">\n", - "an example</a> inline link.</p>\n", - "\n", - "<p><a href=\"http://example.net/\">This link</a> has no\n", - "title attribute.</p>\n"), - - para("If you're referring to a local resource on the same server, you can\n" + - "use relative paths:"), - - verb("See my [About](/about/) page for details.\n"), - - para("Reference-style links use a second set of square brackets, inside\n" + - "which you place a label of your choosing to identify the link:"), - - verb("This is [an example][id] reference-style link.\n"), - - para("You can optionally use a space to separate the sets of brackets:"), - - verb("This is [an example] [id] reference-style link.\n"), - - para("Then, anywhere in the document, you define your link label like this,\n" + - "on a line by itself:"), - - verb("[id]: http://example.com/ \"Optional Title Here\"\n"), - - para("That is:"), - - list(:BULLET, - item(nil, - para("Square brackets containing the link identifier (optionally\n" + - "indented from the left margin using up to three spaces);")), - item(nil, - para("followed by a colon;")), - item(nil, - para("followed by one or more spaces (or tabs);")), - item(nil, - para("followed by the URL for the link;")), - item(nil, - para("optionally followed by a title attribute for the link, enclosed\n" + - "in double or single quotes."))), - - para("The link URL may, optionally, be surrounded by angle brackets:"), - - verb("[id]: <http://example.com/> \"Optional Title Here\"\n"), - - para("You can put the title attribute on the next line and use extra spaces\n" + - "or tabs for padding, which tends to look better with longer URLs:"), - - verb("[id]: http://example.com/longish/path/to/resource/here\n", - " \"Optional Title Here\"\n"), - - para("Link definitions are only used for creating links during Markdown\n" + - "processing, and are stripped from your document in the HTML output."), - - para("Link definition names may consist of letters, numbers, spaces, and punctuation -- but they are _not_ case sensitive. E.g. these two links:"), - - verb("[link text][a]\n", - "[link text][A]\n"), - - para("are equivalent."), - - para("The <em>implicit link name</em> shortcut allows you to omit the name of the\n" + - "link, in which case the link text itself is used as the name.\n" + - "Just use an empty set of square brackets -- e.g., to link the word\n" + - "\"Google\" to the google.com web site, you could simply write:"), - - verb("[Google][]\n"), - - para("And then define the link:"), - - verb("[Google]: http://google.com/\n"), - - para("Because link names may contain spaces, this shortcut even works for\n" + - "multiple words in the link text:"), - - - verb("Visit [Daring Fireball][] for more information.\n"), - - para("And then define the link:"), - - verb("[Daring Fireball]: http://daringfireball.net/\n"), - - para("Link definitions can be placed anywhere in your Markdown document. I\n" + - "tend to put them immediately after each paragraph in which they're\n" + - "used, but if you want, you can put them all at the end of your\n" + - "document, sort of like footnotes."), - - para("Here's an example of reference links in action:"), - - verb("I get 10 times more traffic from [Google] [1] than from\n", - "[Yahoo] [2] or [MSN] [3].\n", - "\n", - " [1]: http://google.com/ \"Google\"\n", - " [2]: http://search.yahoo.com/ \"Yahoo Search\"\n", - " [3]: http://search.msn.com/ \"MSN Search\"\n"), - - para("Using the implicit link name shortcut, you could instead write:"), - - verb("I get 10 times more traffic from [Google][] than from\n", - "[Yahoo][] or [MSN][].\n", - "\n", - " [google]: http://google.com/ \"Google\"\n", - " [yahoo]: http://search.yahoo.com/ \"Yahoo Search\"\n", - " [msn]: http://search.msn.com/ \"MSN Search\"\n"), - - para("Both of the above examples will produce the following HTML output:"), - - verb("<p>I get 10 times more traffic from <a href=\"http://google.com/\"\n", - "title=\"Google\">Google</a> than from\n", - "<a href=\"http://search.yahoo.com/\" title=\"Yahoo Search\">Yahoo</a>\n", - "or <a href=\"http://search.msn.com/\" title=\"MSN Search\">MSN</a>.</p>\n"), - - para("For comparison, here is the same paragraph written using\n" + - "Markdown's inline link style:"), - - verb("I get 10 times more traffic from [Google](http://google.com/ \"Google\")\n", - "than from [Yahoo](http://search.yahoo.com/ \"Yahoo Search\") or\n", - "[MSN](http://search.msn.com/ \"MSN Search\").\n"), - - para("The point of reference-style links is not that they're easier to\n" + - "write. The point is that with reference-style links, your document\n" + - "source is vastly more readable. Compare the above examples: using\n" + - "reference-style links, the paragraph itself is only 81 characters\n" + - "long; with inline-style links, it's 176 characters; and as raw HTML,\n" + - "it's 234 characters. In the raw HTML, there's more markup than there\n" + - "is text."), - - para("With Markdown's reference-style links, a source document much more\n" + - "closely resembles the final output, as rendered in a browser. By\n" + - "allowing you to move the markup-related metadata out of the paragraph,\n" + - "you can add links without interrupting the narrative flow of your\n" + - "prose."), - - raw("<h3 id=\"em\">Emphasis</h3>"), - - para("Markdown treats asterisks (<code>*</code>) and underscores (<code>_</code>) as indicators of\n" + - "emphasis. Text wrapped with one <code>*</code> or <code>_</code> will be wrapped with an\n" + - "HTML <code><em></code> tag; double <code>*</code>'s or <code>_</code>'s will be wrapped with an HTML\n" + - "<code><strong></code> tag. E.g., this input:"), - - verb("*single asterisks*\n", - "\n", - "_single underscores_\n", - "\n", - "**double asterisks**\n", - "\n", - "__double underscores__\n"), - - para("will produce:"), - - verb("<em>single asterisks</em>\n", - "\n", - "<em>single underscores</em>\n", - "\n", - "<strong>double asterisks</strong>\n", - "\n", - "<strong>double underscores</strong>\n"), - - para("You can use whichever style you prefer; the lone restriction is that\n" + - "the same character must be used to open and close an emphasis span."), - - para("Emphasis can be used in the middle of a word:"), - - verb("un*fucking*believable\n"), - - para("But if you surround an <code>*</code> or <code>_</code> with spaces, it'll be treated as a\n" + - "literal asterisk or underscore."), - - para("To produce a literal asterisk or underscore at a position where it\n" + - "would otherwise be used as an emphasis delimiter, you can backslash\n" + - "escape it:"), - - verb("\\*this text is surrounded by literal asterisks\\*\n"), - - raw("<h3 id=\"code\">Code</h3>"), - - para("To indicate a span of code, wrap it with backtick quotes (<code>`</code>).\n" + - "Unlike a pre-formatted code block, a code span indicates code within a\n" + - "normal paragraph. For example:"), - - verb("Use the `printf()` function.\n"), - - para("will produce:"), - - verb("<p>Use the <code>printf()</code> function.</p>\n"), - - para("To include a literal backtick character within a code span, you can use\n" + - "multiple backticks as the opening and closing delimiters:"), - - verb("``There is a literal backtick (`) here.``\n"), - - para("which will produce this:"), - - verb("<p><code>There is a literal backtick (`) here.</code></p>\n"), - - para("The backtick delimiters surrounding a code span may include spaces --\n" + - "one after the opening, one before the closing. This allows you to place\n" + - "literal backtick characters at the beginning or end of a code span:"), - - verb("A single backtick in a code span: `` ` ``\n", - "\n", - "A backtick-delimited string in a code span: `` `foo` ``\n"), - - para("will produce:"), - - verb("<p>A single backtick in a code span: <code>`</code></p>\n", - "\n", - "<p>A backtick-delimited string in a code span: <code>`foo`</code></p>\n"), - - para("With a code span, ampersands and angle brackets are encoded as HTML\n" + - "entities automatically, which makes it easy to include example HTML\n" + - "tags. Markdown will turn this:"), - - verb("Please don't use any `<blink>` tags.\n"), - - para("into:"), - - verb("<p>Please don't use any <code><blink></code> tags.</p>\n"), - - para("You can write this:"), - - verb("`—` is the decimal-encoded equivalent of `—`.\n"), - - para("to produce:"), - - verb( "<p><code>&#8212;</code> is the decimal-encoded\n", - "equivalent of <code>&mdash;</code>.</p>\n"), - - raw("<h3 id=\"img\">Images</h3>"), - - para("Admittedly, it's fairly difficult to devise a \"natural\" syntax for\n" + - "placing images into a plain text document format."), - - para("Markdown uses an image syntax that is intended to resemble the syntax\n" + - "for links, allowing for two styles: _inline_ and _reference_."), - - para("Inline image syntax looks like this:"), - - verb("![Alt text](/path/to/img.jpg)\n", - "\n", - "![Alt text](/path/to/img.jpg \"Optional title\")\n"), - - para("That is:"), - - list(:BULLET, - item(nil, - para("An exclamation mark: <code>!</code>;")), - item(nil, - para("followed by a set of square brackets, containing the <code>alt</code>\n" + - "attribute text for the image;")), - item(nil, - para("followed by a set of parentheses, containing the URL or path to\n" + - "the image, and an optional <code>title</code> attribute enclosed in double\n" + - "or single quotes."))), - - para("Reference-style image syntax looks like this:"), - - verb("![Alt text][id]\n"), - - para("Where \"id\" is the name of a defined image reference. Image references\n" + - "are defined using syntax identical to link references:"), - - verb("[id]: url/to/image \"Optional title attribute\"\n"), - - para("As of this writing, Markdown has no syntax for specifying the\n" + - "dimensions of an image; if this is important to you, you can simply\n" + - "use regular HTML <code><img></code> tags."), - - rule(1), - - raw("<h2 id=\"misc\">Miscellaneous</h2>"), - - raw("<h3 id=\"autolink\">Automatic Links</h3>"), - - para("Markdown supports a shortcut style for creating \"automatic\" links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:"), - - verb("<http://example.com/>\n"), - - para("Markdown will turn this into:"), - - verb("<a href=\"http://example.com/\">http://example.com/</a>\n"), - - para("Automatic links for email addresses work similarly, except that\n" + - "Markdown will also perform a bit of randomized decimal and hex\n" + - "entity-encoding to help obscure your address from address-harvesting\n" + - "spambots. For example, Markdown will turn this:"), - - verb("<address@example.com>\n"), - - para("into something like this:"), - - verb("<a href=\"mailto:addre\n", - "ss@example.co\n", - "m\">address@exa\n", - "mple.com</a>\n"), - - para("which will render in a browser as a clickable link to \"address@example.com\"."), - - para("(This sort of entity-encoding trick will indeed fool many, if not\n" + - "most, address-harvesting bots, but it definitely won't fool all of\n" + - "them. It's better than nothing, but an address published in this way\n" + - "will probably eventually start receiving spam.)"), - - raw("<h3 id=\"backslash\">Backslash Escapes</h3>"), - - para("Markdown allows you to use backslash escapes to generate literal\n" + - "characters which would otherwise have special meaning in Markdown's\n" + - "formatting syntax. For example, if you wanted to surround a word with\n" + - "literal asterisks (instead of an HTML <code><em></code> tag), you can backslashes\n" + - "before the asterisks, like this:"), - - verb("\\*literal asterisks\\*\n"), - - para("Markdown provides backslash escapes for the following characters:"), - - verb("\\ backslash\n", - "` backtick\n", - "* asterisk\n", - "_ underscore\n", - "{} curly braces\n", - "[] square brackets\n", - "() parentheses\n", - "# hash mark\n", - "+ plus sign\n", - "- minus sign (hyphen)\n", - ". dot\n", - "! exclamation mark\n")) - - assert_equal expected, doc - end - - def test_nested_blockquotes - input = File.read "#{MARKDOWN_TEST_PATH}/Nested blockquotes.text" - - doc = @parser.parse input - - expected = - doc( - block( - para("foo"), - block( - para("bar")), - para("foo"))) - - assert_equal expected, doc - end - - def test_ordered_and_unordered_lists - input = File.read "#{MARKDOWN_TEST_PATH}/Ordered and unordered lists.text" - - doc = @parser.parse input - - expected = - doc( - head(2, 'Unordered'), - - para('Asterisks tight:'), - list(:BULLET, - item(nil, para("asterisk 1")), - item(nil, para("asterisk 2")), - item(nil, para("asterisk 3"))), - para('Asterisks loose:'), - list(:BULLET, - item(nil, para("asterisk 1")), - item(nil, para("asterisk 2")), - item(nil, para("asterisk 3"))), - - rule(1), - - para("Pluses tight:"), - list(:BULLET, - item(nil, para("Plus 1")), - item(nil, para("Plus 2")), - item(nil, para("Plus 3"))), - para("Pluses loose:"), - list(:BULLET, - item(nil, para("Plus 1")), - item(nil, para("Plus 2")), - item(nil, para("Plus 3"))), - - rule(1), - - para("Minuses tight:"), - list(:BULLET, - item(nil, para("Minus 1")), - item(nil, para("Minus 2")), - item(nil, para("Minus 3"))), - para("Minuses loose:"), - list(:BULLET, - item(nil, para("Minus 1")), - item(nil, para("Minus 2")), - item(nil, para("Minus 3"))), - - head(2, "Ordered"), - - para("Tight:"), - list(:NUMBER, - item(nil, para("First")), - item(nil, para("Second")), - item(nil, para("Third"))), - para("and:"), - list(:NUMBER, - item(nil, para("One")), - item(nil, para("Two")), - item(nil, para("Three"))), - - para("Loose using tabs:"), - list(:NUMBER, - item(nil, para("First")), - item(nil, para("Second")), - item(nil, para("Third"))), - para("and using spaces:"), - list(:NUMBER, - item(nil, para("One")), - item(nil, para("Two")), - item(nil, para("Three"))), - - para("Multiple paragraphs:"), - list(:NUMBER, - item(nil, - para("Item 1, graf one."), - para("Item 2. graf two. The quick brown fox " + - "jumped over the lazy dog's\nback.")), - item(nil, para("Item 2.")), - item(nil, para("Item 3."))), - - head(2, "Nested"), - list(:BULLET, - item(nil, - para("Tab"), - list(:BULLET, - item(nil, - para("Tab"), - list(:BULLET, - item(nil, - para("Tab"))))))), - - para("Here's another:"), - list(:NUMBER, - item(nil, para("First")), - item(nil, para("Second:"), - list(:BULLET, - item(nil, para("Fee")), - item(nil, para("Fie")), - item(nil, para("Foe")))), - item(nil, para("Third"))), - - para("Same thing but with paragraphs:"), - list(:NUMBER, - item(nil, para("First")), - item(nil, para("Second:"), - list(:BULLET, - item(nil, para("Fee")), - item(nil, para("Fie")), - item(nil, para("Foe")))), - item(nil, para("Third"))), - - para("This was an error in Markdown 1.0.1:"), - list(:BULLET, - item(nil, - para("this"), - list(:BULLET, - item(nil, para("sub"))), - para("that")))) - - assert_equal expected, doc - end - - def test_strong_and_em_together - input = File.read "#{MARKDOWN_TEST_PATH}/Strong and em together.text" - - doc = @parser.parse input - - expected = - doc( - para("<b><em>This is strong and em.</em></b>"), - para("So is <b>_this_</b> word."), - para("<b><em>This is strong and em.</em></b>"), - para("So is <b>_this_</b> word.")) - - assert_equal expected, doc - end - - def test_tabs - input = File.read "#{MARKDOWN_TEST_PATH}/Tabs.text" - - doc = @parser.parse input - - expected = - doc( - list(:BULLET, - item(nil, - para("this is a list item\nindented with tabs")), - item(nil, - para("this is a list item\nindented with spaces"))), - - para("Code:"), - - verb("this code block is indented by one tab\n"), - - para("And:"), - - verb("\tthis code block is indented by two tabs\n"), - - para("And:"), - - verb( - "+\tthis is an example list item\n", - "\tindented with tabs\n", - "\n", - "+ this is an example list item\n", - " indented with spaces\n")) - - assert_equal expected, doc - end - - def test_tidiness - input = File.read "#{MARKDOWN_TEST_PATH}/Tidiness.text" - - doc = @parser.parse input - - expected = - doc( - block( - para("A list within a blockquote:"), - list(:BULLET, - item(nil, para("asterisk 1")), - item(nil, para("asterisk 2")), - item(nil, para("asterisk 3"))))) - - assert_equal expected, doc - end - -end diff --git a/test/rdoc/test_rdoc_markup.rb b/test/rdoc/test_rdoc_markup.rb deleted file mode 100644 index 4d79f8bc3f..0000000000 --- a/test/rdoc/test_rdoc_markup.rb +++ /dev/null @@ -1,95 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkup < RDoc::TestCase - - def test_class_parse - expected = @RM::Document.new( - @RM::Paragraph.new('hello')) - - assert_equal expected, RDoc::Markup.parse('hello') - end - - def test_convert - str = <<-STR -now is -the time - - hello - dave - -1. l1 -2. l2 - STR - - m = RDoc::Markup.new - - tt = RDoc::Markup::ToTest.new m - - out = m.convert str, tt - - expected = [ - "now is the time", - "\n", - " hello\n dave\n", - "1: ", - "l1", - "1: ", - "l2", - ] - - assert_equal expected, out - end - - def test_convert_custom_markup - str = <<-STR -{stricken} - STR - - m = RDoc::Markup.new - m.add_word_pair '{', '}', :STRIKE - - tt = RDoc::Markup::ToTest.new nil, m - tt.add_tag :STRIKE, 'STRIKE ', ' STRIKE' - - out = m.convert str, tt - - expected = [ - "STRIKE stricken STRIKE", - ] - - assert_equal expected, out - end - - def test_convert_document - doc = RDoc::Markup::Parser.parse <<-STR -now is -the time - - hello - dave - -1. l1 -2. l2 - STR - - m = RDoc::Markup.new - - tt = RDoc::Markup::ToTest.new m - - out = m.convert doc, tt - - expected = [ - "now is the time", - "\n", - " hello\n dave\n", - "1: ", - "l1", - "1: ", - "l2", - ] - - assert_equal expected, out - end - -end diff --git a/test/rdoc/test_rdoc_markup_attribute_manager.rb b/test/rdoc/test_rdoc_markup_attribute_manager.rb deleted file mode 100644 index dcae48525d..0000000000 --- a/test/rdoc/test_rdoc_markup_attribute_manager.rb +++ /dev/null @@ -1,395 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupAttributeManager < RDoc::TestCase - - def setup - super - - @am = RDoc::Markup::AttributeManager.new - - @bold_on = @am.changed_attribute_by_name([], [:BOLD]) - @bold_off = @am.changed_attribute_by_name([:BOLD], []) - - @tt_on = @am.changed_attribute_by_name([], [:TT]) - @tt_off = @am.changed_attribute_by_name([:TT], []) - - @em_on = @am.changed_attribute_by_name([], [:EM]) - @em_off = @am.changed_attribute_by_name([:EM], []) - - @bold_em_on = @am.changed_attribute_by_name([], [:BOLD] | [:EM]) - @bold_em_off = @am.changed_attribute_by_name([:BOLD] | [:EM], []) - - @em_then_bold = @am.changed_attribute_by_name([:EM], [:EM] | [:BOLD]) - - @em_to_bold = @am.changed_attribute_by_name([:EM], [:BOLD]) - - @am.add_word_pair("{", "}", :WOMBAT) - @wombat_on = @am.changed_attribute_by_name([], [:WOMBAT]) - @wombat_off = @am.changed_attribute_by_name([:WOMBAT], []) - - @klass = RDoc::Markup::AttributeManager - @formatter = RDoc::Markup::Formatter.new @rdoc.options - @formatter.add_tag :BOLD, '<B>', '</B>' - @formatter.add_tag :EM, '<EM>', '</EM>' - @formatter.add_tag :TT, '<CODE>', '</CODE>' - end - - def crossref(text) - crossref_bitmap = @am.attributes.bitmap_for(:_REGEXP_HANDLING_) | - @am.attributes.bitmap_for(:CROSSREF) - - [ @am.changed_attribute_by_name([], [:CROSSREF, :_REGEXP_HANDLING_]), - RDoc::Markup::RegexpHandling.new(crossref_bitmap, text), - @am.changed_attribute_by_name([:CROSSREF, :_REGEXP_HANDLING_], []) - ] - end - - def test_adding - assert_equal(["cat ", @wombat_on, "and", @wombat_off, " dog" ], - @am.flow("cat {and} dog")) - #assert_equal(["cat {and} dog" ], @am.flow("cat \\{and} dog")) - end - - def test_add_html_tag - @am.add_html("Test", :TEST) - tags = @am.html_tags - assert_equal(6, tags.size) - assert(tags.has_key?("test")) - end - - def test_add_regexp_handling - @am.add_regexp_handling "WikiWord", :WIKIWORD - regexp_handlings = @am.regexp_handlings - - assert_equal 1, regexp_handlings.size - assert regexp_handlings.assoc "WikiWord" - end - - def test_add_word_pair - @am.add_word_pair '%', '&', 'percent and' - - assert @am.word_pair_map.include?(/(%)(\S+)(&)/) - assert @am.protectable.include?('%') - assert !@am.protectable.include?('&') - end - - def test_add_word_pair_angle - e = assert_raise ArgumentError do - @am.add_word_pair '<', '>', 'angles' - end - - assert_equal "Word flags may not start with '<'", e.message - end - - def test_add_word_pair_invalid - assert_raise ArgumentError do - @am.add_word_pair("<", "<", :TEST) - end - end - - def test_add_word_pair_map - @am.add_word_pair("x", "y", :TEST) - - word_pair_map = @am.word_pair_map - - assert_includes word_pair_map.keys.map { |r| r.source }, "(x)(\\S+)(y)" - end - - def test_add_word_pair_matching - @am.add_word_pair '^', '^', 'caret' - - assert @am.matching_word_pairs.include?('^') - assert @am.protectable.include?('^') - end - - def test_basic - assert_equal(["cat"], @am.flow("cat")) - - assert_equal(["cat ", @bold_on, "and", @bold_off, " dog"], - @am.flow("cat *and* dog")) - - assert_equal(["cat ", @bold_on, "AND", @bold_off, " dog"], - @am.flow("cat *AND* dog")) - - assert_equal(["cat ", @em_on, "And", @em_off, " dog"], - @am.flow("cat _And_ dog")) - - assert_equal(["cat *and dog*"], @am.flow("cat *and dog*")) - - assert_equal(["*cat and* dog"], @am.flow("*cat and* dog")) - - assert_equal(["cat *and ", @bold_on, "dog", @bold_off], - @am.flow("cat *and *dog*")) - - assert_equal(["cat ", @em_on, "and", @em_off, " dog"], - @am.flow("cat _and_ dog")) - - assert_equal(["cat_and_dog"], - @am.flow("cat_and_dog")) - - assert_equal(["cat ", @tt_on, "and", @tt_off, " dog"], - @am.flow("cat +and+ dog")) - - assert_equal(["cat ", @tt_on, "X::Y", @tt_off, " dog"], - @am.flow("cat +X::Y+ dog")) - - assert_equal(["cat ", @bold_on, "a_b_c", @bold_off, " dog"], - @am.flow("cat *a_b_c* dog")) - - assert_equal(["cat __ dog"], - @am.flow("cat __ dog")) - - assert_equal(["cat ", @em_on, "_", @em_off, " dog"], - @am.flow("cat ___ dog")) - - assert_equal(["cat and ", @em_on, "5", @em_off, " dogs"], - @am.flow("cat and _5_ dogs")) - - assert_equal([@tt_on, "__id__", @tt_off], @am.flow("+__id__+")) - end - - def test_bold - assert_equal [@bold_on, 'bold', @bold_off], - @am.flow("*bold*") - - assert_equal [@bold_on, 'Bold:', @bold_off], - @am.flow("*Bold:*") - - assert_equal [@bold_on, '\\bold', @bold_off], - @am.flow("*\\bold*") - end - - def test_bold_html_escaped - assert_equal ['cat <b>dog</b>'], @am.flow('cat \<b>dog</b>') - end - - def test_combined - assert_equal(["cat ", @em_on, "and", @em_off, " ", @bold_on, "dog", @bold_off], - @am.flow("cat _and_ *dog*")) - - assert_equal(["cat ", @em_on, "a__nd", @em_off, " ", @bold_on, "dog", @bold_off], - @am.flow("cat _a__nd_ *dog*")) - end - - def test_convert_attrs - str = '+foo+'.dup - attrs = RDoc::Markup::AttrSpan.new str.length, @am.exclusive_bitmap - - @am.convert_attrs str, attrs, true - @am.convert_attrs str, attrs - - assert_equal "\000foo\000", str - - str = '+:foo:+'.dup - attrs = RDoc::Markup::AttrSpan.new str.length, @am.exclusive_bitmap - - @am.convert_attrs str, attrs, true - @am.convert_attrs str, attrs - - assert_equal "\000:foo:\000", str - - str = '+x-y+'.dup - attrs = RDoc::Markup::AttrSpan.new str.length, @am.exclusive_bitmap - - @am.convert_attrs str, attrs, true - @am.convert_attrs str, attrs - - assert_equal "\000x-y\000", str - end - - def test_convert_attrs_ignores_code - assert_equal 'foo <CODE>__send__</CODE> bar', output('foo <code>__send__</code> bar') - end - - def test_convert_attrs_ignores_tt - assert_equal 'foo <CODE>__send__</CODE> bar', output('foo <tt>__send__</tt> bar') - end - - def test_convert_attrs_preserves_double - assert_equal 'foo.__send__ :bar', output('foo.__send__ :bar') - assert_equal 'use __FILE__ to', output('use __FILE__ to') - end - - def test_convert_attrs_does_not_ignore_after_tt - assert_equal 'the <CODE>IF:</CODE><EM>key</EM> directive', output('the <tt>IF:</tt>_key_ directive') - end - - def test_escapes - assert_equal '<CODE>text</CODE>', output('<tt>text</tt>') - assert_equal '<tt>text</tt>', output('\\<tt>text</tt>') - assert_equal '<tt>', output('\\<tt>') - assert_equal '<CODE><tt></CODE>', output('<tt>\\<tt></tt>') - assert_equal '<CODE>\\<tt></CODE>', output('<tt>\\\\<tt></tt>') - assert_equal '<B>text</B>', output('*text*') - assert_equal '*text*', output('\\*text*') - assert_equal '\\', output('\\') - assert_equal '\\text', output('\\text') - assert_equal '\\\\text', output('\\\\text') - assert_equal 'text \\ text', output('text \\ text') - - assert_equal 'and <CODE>\\s</CODE> matches space', - output('and <tt>\\s</tt> matches space') - assert_equal 'use <CODE><tt>text</CODE></tt> for code', - output('use <tt>\\<tt>text</tt></tt> for code') - assert_equal 'use <CODE><tt>text</tt></CODE> for code', - output('use <tt>\\<tt>text\\</tt></tt> for code') - assert_equal 'use <tt><tt>text</tt></tt> for code', - output('use \\<tt>\\<tt>text</tt></tt> for code') - assert_equal 'use <tt><CODE>text</CODE></tt> for code', - output('use \\<tt><tt>text</tt></tt> for code') - assert_equal 'use <CODE>+text+</CODE> for code', - output('use <tt>\\+text+</tt> for code') - assert_equal 'use <tt><CODE>text</CODE></tt> for code', - output('use \\<tt>+text+</tt> for code') - assert_equal 'illegal <tag>not</tag> changed', - output('illegal <tag>not</tag> changed') - assert_equal 'unhandled <p>tag</p> unchanged', - output('unhandled <p>tag</p> unchanged') - end - - def test_exclude_tag - assert_equal '<CODE>aaa</CODE>[:symbol]', output('+aaa+[:symbol]') - assert_equal '<CODE>aaa[:symbol]</CODE>', output('+aaa[:symbol]+') - assert_equal 'aaa[:symbol]', output('aaa[:symbol]') - assert_equal '<B><CODE>index</CODE></B>', output('<b><tt>index</tt></b>') - end - - def test_exclude_tag_flow - assert_equal [@tt_on, "aaa", @tt_off, "[:symbol]"], - @am.flow("+aaa+[:symbol]") - assert_equal [@tt_on, "aaa[:symbol]", @tt_off], - @am.flow("+aaa[:symbol]+") - assert_equal ["aaa[:symbol]"], - @am.flow("aaa[:symbol]") - end - - def test_html_like_em_bold - assert_equal ["cat ", @em_on, "and ", @em_to_bold, "dog", @bold_off], - @am.flow("cat <i>and </i><b>dog</b>") - end - - def test_html_like_em_bold_SGML - assert_equal ["cat ", @em_on, "and ", @em_to_bold, "dog", @bold_off], - @am.flow("cat <i>and <b></i>dog</b>") - end - - def test_html_like_em_bold_nested_1 - assert_equal(["cat ", @bold_em_on, "and", @bold_em_off, " dog"], - @am.flow("cat <i><b>and</b></i> dog")) - end - - def test_html_like_em_bold_nested_2 - assert_equal ["cat ", @em_on, "and ", @em_then_bold, "dog", @bold_em_off], - @am.flow("cat <i>and <b>dog</b></i>") - end - - def test_html_like_em_bold_nested_mixed_case - assert_equal ["cat ", @em_on, "and ", @em_then_bold, "dog", @bold_em_off], - @am.flow("cat <i>and <B>dog</B></I>") - end - - def test_html_like_em_bold_mixed_case - assert_equal ["cat ", @em_on, "and", @em_off, " ", @bold_on, "dog", @bold_off], - @am.flow("cat <i>and</i> <B>dog</b>") - end - - def test_html_like_teletype - assert_equal ["cat ", @tt_on, "dog", @tt_off], - @am.flow("cat <tt>dog</Tt>") - end - - def test_html_like_teletype_em_bold_SGML - assert_equal [@tt_on, "cat", @tt_off, " ", @em_on, "and ", @em_to_bold, "dog", @bold_off], - @am.flow("<tt>cat</tt> <i>and <b></i>dog</b>") - end - - def test_initial_html - html_tags = @am.html_tags - assert html_tags.is_a?(Hash) - assert_equal(5, html_tags.size) - end - - def test_initial_word_pairs - word_pairs = @am.matching_word_pairs - assert word_pairs.is_a?(Hash) - assert_equal(3, word_pairs.size) - end - - def test_mask_protected_sequence - def @am.str() @str end - def @am.str=(str) @str = str end - - @am.str = '<code>foo</code>'.dup - @am.mask_protected_sequences - - assert_equal "<code>foo</code>", @am.str - - @am.str = '<code>foo\\</code>'.dup - @am.mask_protected_sequences - - assert_equal "<code>foo<\x04/code>", @am.str, 'escaped close' - - @am.str = '<code>foo\\\\</code>'.dup - @am.mask_protected_sequences - - assert_equal "<code>foo\\</code>", @am.str, 'escaped backslash' - end - - def test_protect - assert_equal(['cat \\ dog'], - @am.flow('cat \\ dog')) - - assert_equal(["cat <tt>dog</Tt>"], - @am.flow("cat \\<tt>dog</Tt>")) - - assert_equal(["cat ", @em_on, "and", @em_off, " <B>dog</b>"], - @am.flow("cat <i>and</i> \\<B>dog</b>")) - - assert_equal(["*word* or <b>text</b>"], - @am.flow("\\*word* or \\<b>text</b>")) - - assert_equal(["_cat_", @em_on, "dog", @em_off], - @am.flow("\\_cat_<i>dog</i>")) - end - - def test_lost_tag_for_the_second_time - str = "cat <tt>dog</tt>" - assert_equal(["cat ", @tt_on, "dog", @tt_off], - @am.flow(str)) - assert_equal(["cat ", @tt_on, "dog", @tt_off], - @am.flow(str)) - end - - def test_regexp_handling - @am.add_regexp_handling(RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF) - - # - # The apostrophes in "cats'" and "dogs'" suppress the flagging of these - # words as potential cross-references, which is necessary for the unit - # tests. Unfortunately, the markup engine right now does not actually - # check whether a cross-reference is valid before flagging it. - # - assert_equal(["cats'"], @am.flow("cats'")) - - assert_equal(["cats' ", crossref("#fred"), " dogs'"].flatten, - @am.flow("cats' #fred dogs'")) - - assert_equal([crossref("#fred"), " dogs'"].flatten, - @am.flow("#fred dogs'")) - - assert_equal(["cats' ", crossref("#fred")].flatten, @am.flow("cats' #fred")) - - assert_equal(["(", crossref("#fred"), ")"].flatten, @am.flow("(#fred)")) - end - - def test_tt_html - assert_equal [@tt_on, '"\n"', @tt_off], - @am.flow('<tt>"\n"</tt>') - end - - def output str - @formatter.convert_flow @am.flow str - end - -end diff --git a/test/rdoc/test_rdoc_markup_attributes.rb b/test/rdoc/test_rdoc_markup_attributes.rb deleted file mode 100644 index 1ab408d801..0000000000 --- a/test/rdoc/test_rdoc_markup_attributes.rb +++ /dev/null @@ -1,39 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupAttributes < RDoc::TestCase - - def setup - super - - @as = RDoc::Markup::Attributes.new - end - - def test_bitmap_for - assert_equal 2, @as.bitmap_for('two') - assert_equal 2, @as.bitmap_for('two') - assert_equal 4, @as.bitmap_for('three') - end - - def test_as_string - @as.bitmap_for 'two' - @as.bitmap_for 'three' - - assert_equal 'none', @as.as_string(0) - assert_equal '_REGEXP_HANDLING_', @as.as_string(1) - assert_equal 'two', @as.as_string(2) - assert_equal '_REGEXP_HANDLING_,two', @as.as_string(3) - end - - def test_each_name_of - @as.bitmap_for 'two' - @as.bitmap_for 'three' - - assert_equal %w[], @as.each_name_of(0).to_a - assert_equal %w[], @as.each_name_of(1).to_a - assert_equal %w[two], @as.each_name_of(2).to_a - assert_equal %w[three], @as.each_name_of(4).to_a - assert_equal %w[two three], @as.each_name_of(6).to_a - end - -end diff --git a/test/rdoc/test_rdoc_markup_document.rb b/test/rdoc/test_rdoc_markup_document.rb deleted file mode 100644 index e4f3b9daf1..0000000000 --- a/test/rdoc/test_rdoc_markup_document.rb +++ /dev/null @@ -1,207 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupDocument < RDoc::TestCase - - def setup - super - - @d = @RM::Document.new - end - - def test_append - @d << @RM::Paragraph.new('hi') - - expected = @RM::Document.new @RM::Paragraph.new('hi') - - assert_equal expected, @d - end - - def test_append_document - @d << @RM::Document.new - - assert_empty @d - - @d << @RM::Document.new(@RM::Paragraph.new('hi')) - - expected = @RM::Document.new @RM::Paragraph.new('hi'), @RM::BlankLine.new - - assert_equal expected, @d - end - - def test_append_string - @d << '' - - assert_empty @d - - assert_raise ArgumentError do - @d << 'hi' - end - end - - def test_concat - @d.concat [@RM::BlankLine.new, @RM::BlankLine.new] - - refute_empty @d - end - - def test_each - a = @RM::Document.new - b = @RM::Document.new(@RM::Paragraph.new('hi')) - - @d.push a, b - - assert_equal [a, b], @d.map { |sub_doc| sub_doc } - end - - def test_empty_eh - assert_empty @d - - @d << @RM::BlankLine.new - - refute_empty @d - end - - def test_empty_eh_document - d = @RM::Document.new @d - - assert_empty d - end - - def test_equals2 - d2 = @RM::Document.new - - assert_equal @d, d2 - - d2 << @RM::BlankLine.new - - refute_equal @d, d2 - end - - def test_equals2_file - d2 = @RM::Document.new - d2.file = 'file.rb' - - refute_equal @d, d2 - - @d.file = 'file.rb' - - assert_equal @d, d2 - end - - def test_file_equals - @d.file = 'file.rb' - - assert_equal 'file.rb', @d.file - end - - def test_file_equals_top_level - @d.file = @store.add_file 'file.rb' - - assert_equal 'file.rb', @d.file - end - - def test_lt2 - @d << @RM::BlankLine.new - - refute_empty @d - end - - def test_merge - original = @RM::Document.new @RM::Paragraph.new 'original' - original.file = 'file.rb' - root = @RM::Document.new original - - replace = @RM::Document.new @RM::Paragraph.new 'replace' - replace.file = 'file.rb' - - other = @RM::Document.new replace - - result = root.merge other - - inner = @RM::Document.new @RM::Paragraph.new 'replace' - inner.file = 'file.rb' - expected = @RM::Document.new inner - - assert_equal expected, result - end - - def test_merge_add - original = @RM::Document.new @RM::Paragraph.new 'original' - original.file = 'file.rb' - root = @RM::Document.new original - - addition = @RM::Document.new @RM::Paragraph.new 'addition' - addition.file = 'other.rb' - - other = @RM::Document.new addition - - result = root.merge other - - expected = @RM::Document.new original, addition - - assert_equal expected, result - end - - def test_merge_empty - original = @RM::Document.new - root = @RM::Document.new original - - replace = @RM::Document.new @RM::Paragraph.new 'replace' - replace.file = 'file.rb' - - other = @RM::Document.new replace - - result = root.merge other - - inner = @RM::Document.new @RM::Paragraph.new 'replace' - inner.file = 'file.rb' - expected = @RM::Document.new inner - - assert_equal expected, result - end - - def test_push - @d.push @RM::BlankLine.new, @RM::BlankLine.new - - refute_empty @d - end - - def test_table_of_contents - doc = @RM::Document.new( - @RM::Heading.new(1, 'A'), - @RM::Paragraph.new('B'), - @RM::Heading.new(2, 'C'), - @RM::Paragraph.new('D'), - @RM::Heading.new(1, 'E'), - @RM::Paragraph.new('F')) - - expected = [ - @RM::Heading.new(1, 'A'), - @RM::Heading.new(2, 'C'), - @RM::Heading.new(1, 'E'), - ] - - assert_equal expected, doc.table_of_contents - end - - def test_table_of_contents_omit_headings_below - document = doc( - head(1, 'A'), - para('B'), - head(2, 'C'), - para('D'), - head(1, 'E'), - para('F')) - - document.omit_headings_below = 1 - - expected = [ - head(1, 'A'), - head(1, 'E'), - ] - - assert_equal expected, document.table_of_contents - end - -end diff --git a/test/rdoc/test_rdoc_markup_formatter.rb b/test/rdoc/test_rdoc_markup_formatter.rb deleted file mode 100644 index af19d832ca..0000000000 --- a/test/rdoc/test_rdoc_markup_formatter.rb +++ /dev/null @@ -1,181 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupFormatter < RDoc::TestCase - - class ToTest < RDoc::Markup::Formatter - - def initialize markup - super nil, markup - - add_tag :TT, '<code>', '</code>' - end - - def accept_paragraph paragraph - @res += attributes(paragraph.text) - end - - def attributes text - convert_flow @am.flow text.dup - end - - def handle_regexp_CAPS target - "handled #{target.text}" - end - - def start_accepting - @res = "" - end - - def end_accepting - @res - end - - end - - def setup - super - - @markup = @RM.new - @markup.add_regexp_handling(/[A-Z]+/, :CAPS) - - @attribute_manager = @markup.attribute_manager - @attributes = @attribute_manager.attributes - - @to = ToTest.new @markup - - @caps = @attributes.bitmap_for :CAPS - @regexp_handling = @attributes.bitmap_for :_REGEXP_HANDLING_ - @tt = @attributes.bitmap_for :TT - end - - def test_class_gen_relative_url - def gen(from, to) - RDoc::Markup::ToHtml.gen_relative_url from, to - end - - assert_equal 'a.html', gen('a.html', 'a.html') - assert_equal 'b.html', gen('a.html', 'b.html') - - assert_equal 'd.html', gen('a/c.html', 'a/d.html') - assert_equal '../a.html', gen('a/c.html', 'a.html') - assert_equal 'a/c.html', gen('a.html', 'a/c.html') - end - - def regexp_handling_names - @attribute_manager.regexp_handlings.map do |_, mask| - @attributes.as_string mask - end - end - - def test_add_regexp_handling_RDOCLINK - @to.add_regexp_handling_RDOCLINK - - assert_includes regexp_handling_names, 'RDOCLINK' - - def @to.handle_regexp_RDOCLINK target - "<#{target.text}>" - end - - document = doc(para('{foo}[rdoc-label:bar].')) - - formatted = document.accept @to - - assert_equal '{foo}[<rdoc-label:bar>].', formatted - end - - def test_add_regexp_handling_TIDYLINK - @to.add_regexp_handling_TIDYLINK - - assert_includes regexp_handling_names, 'TIDYLINK' - - def @to.handle_regexp_TIDYLINK target - "<#{target.text}>" - end - - document = doc(para('foo[rdoc-label:bar].')) - - formatted = document.accept @to - - assert_equal '<foo[rdoc-label:bar]>.', formatted - - document = doc(para('{foo}[rdoc-label:bar].')) - - formatted = document.accept @to - - assert_equal '<{foo}[rdoc-label:bar]>.', formatted - - document = doc(para('<tt>{abc}</tt>: {foo}[rdoc-label:bar].')) - - formatted = document.accept @to - - assert_equal '<code>{abc}</code>: <{foo}[rdoc-label:bar]>.', formatted - end - - def test_parse_url - scheme, url, id = @to.parse_url 'example/foo' - - assert_equal 'http', scheme - assert_equal 'example/foo', url - assert_nil id - end - - def test_parse_url_anchor - scheme, url, id = @to.parse_url '#foottext-1' - - assert_nil scheme - assert_equal '#foottext-1', url - assert_nil id - end - - def test_parse_url_link - scheme, url, id = @to.parse_url 'link:README.txt' - - assert_equal 'link', scheme - assert_equal 'README.txt', url - assert_nil id - end - - def test_parse_url_link_id - scheme, url, id = @to.parse_url 'link:README.txt#label-foo' - - assert_equal 'link', scheme - assert_equal 'README.txt#label-foo', url - assert_nil id - end - - def test_parse_url_rdoc_label - scheme, url, id = @to.parse_url 'rdoc-label:foo' - - assert_equal 'link', scheme - assert_equal '#foo', url - assert_nil id - - scheme, url, id = @to.parse_url 'rdoc-label:foo:bar' - - assert_equal 'link', scheme - assert_equal '#foo', url - assert_equal ' id="bar"', id - end - - def test_parse_url_scheme - scheme, url, id = @to.parse_url 'http://example/foo' - - assert_equal 'http', scheme - assert_equal 'http://example/foo', url - assert_nil id - - scheme, url, id = @to.parse_url 'https://example/foo' - - assert_equal 'https', scheme - assert_equal 'https://example/foo', url - assert_nil id - end - - def test_convert_tt_regexp_handling - converted = @to.convert '<code>AAA</code>' - - assert_equal '<code>AAA</code>', converted - end - -end diff --git a/test/rdoc/test_rdoc_markup_hard_break.rb b/test/rdoc/test_rdoc_markup_hard_break.rb deleted file mode 100644 index ac67c68d10..0000000000 --- a/test/rdoc/test_rdoc_markup_hard_break.rb +++ /dev/null @@ -1,31 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupHardBreak < RDoc::TestCase - - def setup - super - - @hb = RDoc::Markup::HardBreak.new - end - - def test_accept - visitor = Object.new - - def visitor.accept_hard_break(obj) @obj = obj end - def visitor.obj() @obj end - - @hb.accept visitor - - assert_same @hb, visitor.obj - end - - def test_equals2 - other = RDoc::Markup::HardBreak.new - - assert_equal @hb, other - - refute_equal @hb, Object.new - end - -end diff --git a/test/rdoc/test_rdoc_markup_heading.rb b/test/rdoc/test_rdoc_markup_heading.rb deleted file mode 100644 index de92af91a0..0000000000 --- a/test/rdoc/test_rdoc_markup_heading.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupHeading < RDoc::TestCase - - def setup - super - - @h = RDoc::Markup::Heading.new 1, 'Hello *Friend*!' - end - - def test_aref - assert_equal 'label-Hello+Friend-21', @h.aref - end - - def test_label - assert_equal 'label-Hello+Friend-21', @h.label - assert_equal 'label-Hello+Friend-21', @h.label(nil) - - context = RDoc::NormalClass.new 'Foo' - - assert_equal 'class-Foo-label-Hello+Friend-21', @h.label(context) - end - - def test_plain_html - assert_equal 'Hello <strong>Friend</strong>!', @h.plain_html - end - -end diff --git a/test/rdoc/test_rdoc_markup_include.rb b/test/rdoc/test_rdoc_markup_include.rb deleted file mode 100644 index b3e9b845c3..0000000000 --- a/test/rdoc/test_rdoc_markup_include.rb +++ /dev/null @@ -1,19 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupInclude < RDoc::TestCase - - def setup - super - - @include = @RM::Include.new 'file', [Dir.tmpdir] - end - - def test_equals2 - assert_equal @include, @RM::Include.new('file', [Dir.tmpdir]) - refute_equal @include, @RM::Include.new('file', %w[.]) - refute_equal @include, @RM::Include.new('other', [Dir.tmpdir]) - refute_equal @include, Object.new - end - -end diff --git a/test/rdoc/test_rdoc_markup_indented_paragraph.rb b/test/rdoc/test_rdoc_markup_indented_paragraph.rb deleted file mode 100644 index d2a9cbe5ca..0000000000 --- a/test/rdoc/test_rdoc_markup_indented_paragraph.rb +++ /dev/null @@ -1,53 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupIndentedParagraph < RDoc::TestCase - - def setup - super - - @IP = RDoc::Markup::IndentedParagraph - end - - def test_initialize - ip = @IP.new 2, 'a', 'b' - - assert_equal 2, ip.indent - assert_equal %w[a b], ip.parts - end - - def test_accept - visitor = Object.new - def visitor.accept_indented_paragraph(obj) @obj = obj end - def visitor.obj() @obj end - - paragraph = @IP.new 0 - - paragraph.accept visitor - - assert_equal paragraph, visitor.obj - end - - def test_equals2 - one = @IP.new 1 - two = @IP.new 2 - - assert_equal one, one - refute_equal one, two - end - - def test_text - paragraph = @IP.new(2, 'hello', ' world') - - assert_equal 'hello world', paragraph.text - end - - def test_text_break - paragraph = @IP.new(2, 'hello', hard_break, 'world') - - assert_equal 'helloworld', paragraph.text - - assert_equal "hello\n world", paragraph.text("\n") - end - -end diff --git a/test/rdoc/test_rdoc_markup_paragraph.rb b/test/rdoc/test_rdoc_markup_paragraph.rb deleted file mode 100644 index 1b26846eb3..0000000000 --- a/test/rdoc/test_rdoc_markup_paragraph.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupParagraph < RDoc::TestCase - - def test_accept - visitor = Object.new - def visitor.accept_paragraph(obj) @obj = obj end - def visitor.obj() @obj end - - paragraph = RDoc::Markup::Paragraph.new - - paragraph.accept visitor - - assert_same paragraph, visitor.obj - end - - def test_text - paragraph = para('hello', ' world') - - assert_equal 'hello world', paragraph.text - end - - def test_text_break - paragraph = para('hello', hard_break, 'world') - - assert_equal 'helloworld', paragraph.text - - assert_equal "hello\nworld", paragraph.text("\n") - end - -end diff --git a/test/rdoc/test_rdoc_markup_parser.rb b/test/rdoc/test_rdoc_markup_parser.rb deleted file mode 100644 index 6fccf09612..0000000000 --- a/test/rdoc/test_rdoc_markup_parser.rb +++ /dev/null @@ -1,1684 +0,0 @@ -# coding: utf-8 -# frozen_string_literal: true - -require_relative 'helper' - -class TestRDocMarkupParser < RDoc::TestCase - - def setup - super - - @RMP = @RM::Parser - end - - def test_build_heading - parser = @RMP.new - - parser.tokens.replace [ - [:TEXT, 'heading three', 4, 0], - [:NEWLINE, "\n", 17, 0], - ] - - assert_equal @RM::Heading.new(3, 'heading three'), parser.build_heading(3) - end - - def test_get - parser = util_parser - - assert_equal [:HEADER, 1, 0, 0], parser.get - - assert_equal 7, parser.tokens.length - end - - def test_parse_bullet - str = <<-STR -* l1 -* l2 - STR - - expected = [ - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1')), - @RM::ListItem.new(nil, - @RM::Paragraph.new('l2'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_bullet_utf_8 - str = <<-STR -* 新しい機能 - STR - - expected = [ - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('新しい機能'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_bullet_verbatim_heading - str = <<-STR -* l1 - v - -= H - STR - - expected = [ - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1'), - @RM::Verbatim.new("v\n"))]), - @RM::Heading.new(1, 'H')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_bullet_heading - str = <<-STR -* = l1 - STR - - expected = [ - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Heading.new(1, 'l1'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_bullet_indent - str = <<-STR -* l1 - * l1.1 -* l2 - STR - - expected = [ - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1'), - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1.1'))])), - @RM::ListItem.new(nil, - @RM::Paragraph.new('l2'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_bullet_paragraph - str = <<-STR -now is -* l1 -* l2 -the time - STR - - expected = [ - @RM::Paragraph.new('now is'), - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1')), - @RM::ListItem.new(nil, - @RM::Paragraph.new('l2')), - ]), - @RM::Paragraph.new('the time'), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_bullet_multiline - str = <<-STR -* l1 - l1+ -* l2 - STR - - expected = [ - list(:BULLET, - item(nil, - para('l1 ', 'l1+')), - item(nil, - para('l2')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_bullet_multiparagraph - str = <<-STR -* l1 - - l1+ - STR - - expected = [ - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1'), - @RM::BlankLine.new, - @RM::Paragraph.new('l1+')), - ]), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_bullet_indent_verbatim - str = <<-STR -* l1 - * l1.1 - text - code - code - - text -* l2 - STR - - expected = [ - list(:BULLET, - item(nil, - para('l1'), - list(:BULLET, - item(nil, - para('l1.1 ', 'text'), - verb("code\n", " code\n"), - para('text')))), - item(nil, - para('l2')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_dash - str = <<-STR -- one -- two - STR - - expected = [ - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('one')), - @RM::ListItem.new(nil, - @RM::Paragraph.new('two'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading - str = '= heading one' - - expected = [ - @RM::Heading.new(1, 'heading one')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_three - str = '=== heading three' - - expected = [ - @RM::Heading.new(3, 'heading three')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_bullet - str = '= * heading one' - - expected = [ - @RM::Heading.new(1, '* heading one')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_empty - str = <<-STR -=== -* bullet - STR - - expected = [ - @RM::Heading.new(3, ''), - @RM::BlankLine.new, - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('bullet'))]), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_heading - str = '= =' - - expected = [ - @RM::Heading.new(1, '=')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_lalpha - str = '= b. heading one' - - expected = [ - @RM::Heading.new(1, 'b. heading one')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_label - str = '= [heading one]' - - expected = [ - @RM::Heading.new(1, '[heading one]')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_note - str = '= heading one::' - - expected = [ - @RM::Heading.new(1, 'heading one::')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_number - str = '= 5. heading one' - - expected = [ - @RM::Heading.new(1, '5. heading one')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_heading_ualpha - str = '= B. heading one' - - expected = [ - @RM::Heading.new(1, 'B. heading one')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_label - str = <<-STR -[one] item one -[two] item two - STR - - expected = [ - list(:LABEL, - item(%w[one], - para('item one')), - item(%w[two], - para('item two')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_label_bullet - str = <<-STR -[cat] l1 - * l1.1 -[dog] l2 - STR - - expected = [ - list(:LABEL, - item(%w[cat], - para('l1'), - list(:BULLET, - item(nil, - para('l1.1')))), - item(%w[dog], - para('l2')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_label_multi_label - str = <<-STR -[one] -[two] some description - STR - - expected = [ - list(:LABEL, - item(%w[one two], - para('some description')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_label_multi_line - str = <<-STR -[cat] l1 - continuation -[dog] l2 - STR - - expected = [ - list(:LABEL, - item(%w[cat], - para('l1 ', 'continuation')), - item(%w[dog], - para('l2')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_label_newline - str = <<-STR -[one] - item one -[two] - item two - STR - - expected = [ - list(:LABEL, - item(%w[one], - para('item one')), - item(%w[two], - para('item two')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_lalpha - str = <<-STR -a. l1 -b. l2 - STR - - expected = [ - @RM::List.new(:LALPHA, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1')), - @RM::ListItem.new(nil, - @RM::Paragraph.new('l2'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_lalpha_ualpha - str = <<-STR -a. l1 -b. l2 -A. l3 -A. l4 - STR - - expected = [ - @RM::List.new(:LALPHA, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1')), - @RM::ListItem.new(nil, - @RM::Paragraph.new('l2'))]), - @RM::List.new(:UALPHA, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l3')), - @RM::ListItem.new(nil, - @RM::Paragraph.new('l4'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_lalpha_utf_8 - str = <<-STR -a. 新しい機能 - STR - - expected = [ - @RM::List.new(:LALPHA, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('新しい機能'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_line_break - str = "now is\nthe time \nfor all" - - expected = [ - para('now is ', 'the time'), - blank_line, - para('for all')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_list_list_1 - str = <<-STR -10. para 1 - - [label 1] - para 1.1 - - code - - para 1.2 - STR - - expected = [ - list(:NUMBER, - item(nil, - para('para 1'), - blank_line, - list(:LABEL, - item(%w[label\ 1], - para('para 1.1'), - blank_line, - verb("code\n"), - para('para 1.2')))))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_list_list_2 - str = <<-STR -6. para - - label 1:: text 1 - label 2:: text 2 - STR - - expected = [ - list(:NUMBER, - item(nil, - para('para'), - blank_line, - list(:NOTE, - item(%w[label\ 1], - para('text 1')), - item(%w[label\ 2], - para('text 2')))))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_list_verbatim - str = <<-STR -* one - verb1 - verb2 -* two - STR - - expected = [ - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('one'), - @RM::Verbatim.new("verb1\n", "verb2\n")), - @RM::ListItem.new(nil, - @RM::Paragraph.new('two'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_lists - str = <<-STR -now is -* l1 -1. n1 -2. n2 -* l2 -the time - STR - - expected = [ - @RM::Paragraph.new('now is'), - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1'))]), - @RM::List.new(:NUMBER, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('n1')), - @RM::ListItem.new(nil, - @RM::Paragraph.new('n2'))]), - @RM::List.new(:BULLET, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l2'))]), - @RM::Paragraph.new('the time')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_note - str = <<-STR -one:: item one -two:: item two - STR - - expected = [ - list(:NOTE, - item(%w[one], - para('item one')), - item(%w[two], - para('item two')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_note_empty - str = <<-STR -one:: -two:: - STR - - expected = [ - list(:NOTE, - item(%w[one two], - blank_line))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_note_note - str = <<-STR -one:: two:: - STR - - expected = [ - list(:NOTE, - item(%w[one], - list(:NOTE, - item(%w[two], - blank_line))))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_number_bullet - str = <<-STR -1. l1 - * l1.1 -2. l2 - STR - - expected = [ - list(:NUMBER, - item(nil, - para('l1'), - list(:BULLET, - item(nil, - para('l1.1')))), - item(nil, - para('l2')))] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_paragraph - str = <<-STR -now is the time - -for all good men - STR - - expected = [ - @RM::Paragraph.new('now is the time'), - @RM::BlankLine.new, - @RM::Paragraph.new('for all good men')] - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_paragraph_multiline - str = "now is the time\nfor all good men" - - expected = @RM::Paragraph.new 'now is the time ', 'for all good men' - assert_equal [expected], @RMP.parse(str).parts - end - - def test_parse_paragraph_verbatim - str = <<-STR -now is the time - code _line_ here -for all good men - STR - - expected = [ - @RM::Paragraph.new('now is the time'), - @RM::Verbatim.new("code _line_ here\n"), - @RM::Paragraph.new('for all good men'), - ] - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_rule - str = <<-STR -now is the time - ---- - -for all good men - STR - - expected = [ - @RM::Paragraph.new('now is the time'), - @RM::BlankLine.new, - @RM::Rule.new(1), - @RM::BlankLine.new, - @RM::Paragraph.new('for all good men')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_ualpha - str = <<-STR -A. l1 -B. l2 - STR - - expected = [ - @RM::List.new(:UALPHA, *[ - @RM::ListItem.new(nil, - @RM::Paragraph.new('l1')), - @RM::ListItem.new(nil, - @RM::Paragraph.new('l2'))])] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_trailing_cr - expected = [ @RM::Paragraph.new('Text') ] - assert_equal expected, @RMP.parse("Text\r").parts - end - - def test_parse_verbatim - str = <<-STR -now is - code -the time - STR - - expected = [ - @RM::Paragraph.new('now is'), - @RM::Verbatim.new("code\n"), - @RM::Paragraph.new('the time'), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_bullet - str = <<-STR - * blah - STR - - expected = [ - @RM::Verbatim.new("* blah\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_dash - str = <<-STR - - blah - STR - - expected = [ - @RM::Verbatim.new("- blah\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_fold - str = <<-STR -now is - code - - - code1 - -the time - STR - - expected = [ - @RM::Paragraph.new('now is'), - @RM::Verbatim.new("code\n", "\n", "code1\n"), - @RM::Paragraph.new('the time'), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_heading - str = <<-STR -text - === heading three - STR - - expected = [ - @RM::Paragraph.new('text'), - @RM::Verbatim.new("=== heading three\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_heading2 - str = "text\n code\n=== heading three" - - expected = [ - @RM::Paragraph.new('text'), - @RM::Verbatim.new("code\n"), - @RM::Heading.new(3, 'heading three')] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_label - str = <<-STR - [blah] blah - STR - - expected = [ - @RM::Verbatim.new("[blah] blah\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_lalpha - str = <<-STR - b. blah - STR - - expected = [ - @RM::Verbatim.new("b. blah\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_markup_example - str = <<-STR -text - code - === heading three - STR - - expected = [ - @RM::Paragraph.new('text'), - @RM::Verbatim.new("code\n", "=== heading three\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_merge - str = <<-STR -now is - code - - code1 -the time - STR - - expected = [ - @RM::Paragraph.new('now is'), - @RM::Verbatim.new("code\n", "\n", "code1\n"), - @RM::Paragraph.new('the time'), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_merge2 - str = <<-STR -now is - code - - code1 - - code2 -the time - STR - - expected = [ - @RM::Paragraph.new('now is'), - @RM::Verbatim.new("code\n", "\n", "code1\n", "\n", "code2\n"), - @RM::Paragraph.new('the time'), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_multiline - str = <<-STR -now is - code - code1 -the time - STR - - expected = [ - @RM::Paragraph.new('now is'), - @RM::Verbatim.new("code\n", "code1\n"), - @RM::Paragraph.new('the time'), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_multilevel - str = <<-STR -now is the time - code - more code -for all good men - STR - - expected = [ - @RM::Paragraph.new('now is the time'), - @RM::Verbatim.new(" code\n", - "more code\n"), - @RM::Paragraph.new('for all good men'), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_note - str = <<-STR - blah:: blah - STR - - expected = [ - @RM::Verbatim.new("blah:: blah\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_number - str = <<-STR - 2. blah - STR - - expected = [ - @RM::Verbatim.new("2. blah\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_rule - str = <<-STR -text - - --- lib/blah.rb.orig - +++ lib/blah.rb - STR - - expected = [ - @RM::Paragraph.new('text'), - @RM::BlankLine.new, - @RM::Verbatim.new("--- lib/blah.rb.orig\n", - "+++ lib/blah.rb\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_rule2 - str = <<-STR.chomp -text - - --- - STR - - expected = [ - @RM::Paragraph.new('text'), - @RM::BlankLine.new, - @RM::Verbatim.new("---")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_trim - str = <<-STR -now is - code - - code1 - -the time - STR - - expected = [ - @RM::Paragraph.new('now is'), - @RM::Verbatim.new("code\n", - "\n", - "code1\n"), - @RM::Paragraph.new('the time'), - ] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_verbatim_ualpha - str = <<-STR - B. blah - STR - - expected = [ - @RM::Verbatim.new("B. blah\n")] - - assert_equal expected, @RMP.parse(str).parts - end - - def test_parse_whitespace - expected = [ - @RM::Paragraph.new('hello'), - ] - - assert_equal expected, @RMP.parse('hello').parts - - expected = [ - @RM::Verbatim.new('hello '), - ] - - assert_equal expected, @RMP.parse(' hello ').parts - - expected = [ - @RM::Verbatim.new('hello '), - ] - - assert_equal expected, @RMP.parse(' hello ').parts - - expected = [ - @RM::Paragraph.new('1'), - @RM::Verbatim.new("2\n", ' 3'), - ] - - assert_equal expected, @RMP.parse("1\n 2\n 3").parts - - expected = [ - @RM::Verbatim.new("1\n", - " 2\n", - " 3"), - ] - - assert_equal expected, @RMP.parse(" 1\n 2\n 3").parts - - expected = [ - @RM::Paragraph.new('1'), - @RM::Verbatim.new("2\n", - " 3\n"), - @RM::Paragraph.new('1'), - @RM::Verbatim.new('2'), - ] - - assert_equal expected, @RMP.parse("1\n 2\n 3\n1\n 2").parts - - expected = [ - @RM::Verbatim.new("1\n", - " 2\n", - " 3\n", - "1\n", - ' 2'), - ] - - assert_equal expected, @RMP.parse(" 1\n 2\n 3\n 1\n 2").parts - - expected = [ - @RM::Verbatim.new("1\n", - " 2\n", - "\n", - ' 3'), - ] - - assert_equal expected, @RMP.parse(" 1\n 2\n\n 3").parts - end - - def test_parse_block_quote - expected = [ - @RM::BlockQuote.new(@RM::Paragraph.new("foo")) - ] - assert_equal expected, @RMP.parse(<<-DOC).parts ->>> - foo - DOC - - expected = [ - @RM::BlockQuote.new(@RM::Paragraph.new("foo"), - @RM::Verbatim.new("code\n"), - @RM::Paragraph.new("bar")) - ] - assert_equal expected, @RMP.parse(<<-DOC).parts ->>> - foo - code - bar - DOC - - expected = [ - @RM::BlockQuote.new(@RM::Paragraph.new("foo"), - @RM::BlockQuote.new(@RM::Paragraph.new("bar")), - @RM::Paragraph.new("zot")) - ] - assert_equal expected, @RMP.parse(<<-DOC).parts ->>> - foo - >>> - bar - zot - DOC - end - - def test_peek_token - parser = util_parser - - assert_equal [:HEADER, 1, 0, 0], parser.peek_token - - assert_equal 8, parser.tokens.length - end - - def test_skip - parser = util_parser - - assert_equal [:HEADER, 1, 0, 0], parser.skip(:HEADER) - - assert_equal [:TEXT, 'Heading', 2, 0], parser.get - - assert_equal [:NEWLINE, "\n", 9, 0], parser.peek_token - - assert_raise RDoc::Markup::Parser::ParseError do - parser.skip :NONE - end - - assert_equal [:NEWLINE, "\n", 9, 0], parser.peek_token - - assert_nil parser.skip(:NONE, false) - - assert_equal [:NEWLINE, "\n", 9, 0], parser.peek_token - end - - def test_tokenize_bullet - str = <<-STR -* l1 - STR - - expected = [ - [:BULLET, '*', 0, 0], - [:TEXT, 'l1', 2, 0], - [:NEWLINE, "\n", 4, 0], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_bullet_indent - str = <<-STR -* l1 - * l1.1 - STR - - expected = [ - [:BULLET, '*', 0, 0], - [:TEXT, 'l1', 2, 0], - [:NEWLINE, "\n", 4, 0], - [:BULLET, '*', 2, 1], - [:TEXT, 'l1.1', 4, 1], - [:NEWLINE, "\n", 8, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_heading - str = <<-STR -= Heading -== Heading 2 - STR - - expected = [ - [:HEADER, 1, 0, 0], - [:TEXT, 'Heading', 2, 0], - [:NEWLINE, "\n", 9, 0], - [:HEADER, 2, 0, 1], - [:TEXT, 'Heading 2', 3, 1], - [:NEWLINE, "\n", 12, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_heading_empty - str = <<-STR -=== -* bullet - STR - - expected = [ - [:HEADER, 3, 0, 0], - [:NEWLINE, "\n", 3, 0], - [:BULLET, "*", 0, 1], - [:TEXT, "bullet", 2, 1], - [:NEWLINE, "\n", 8, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_heading_heading - str = <<-STR -= = - STR - - expected = [ - [:HEADER, 1, 0, 0], - [:TEXT, '=', 2, 0], - [:NEWLINE, "\n", 3, 0], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_heading_no_space - str = <<-STR -=Heading -==Heading 2 - STR - - expected = [ - [:HEADER, 1, 0, 0], - [:TEXT, 'Heading', 1, 0], - [:NEWLINE, "\n", 8, 0], - [:HEADER, 2, 0, 1], - [:TEXT, 'Heading 2', 2, 1], - [:NEWLINE, "\n", 11, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_label - str = <<-STR -[cat] l1 -[dog] l1.1 - STR - - expected = [ - [:LABEL, 'cat', 0, 0], - [:TEXT, 'l1', 6, 0], - [:NEWLINE, "\n", 8, 0], - [:LABEL, 'dog', 0, 1], - [:TEXT, 'l1.1', 6, 1], - [:NEWLINE, "\n", 10, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_label_note - str = <<-STR -[label] - note:: - STR - - expected = [ - [:LABEL, 'label', 0, 0], - [:NEWLINE, "\n", 7, 0], - [:NOTE, 'note', 2, 1], - [:NEWLINE, "\n", 8, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_label_newline - str = <<-STR -[cat] - l1 - STR - - expected = [ - [:LABEL, 'cat', 0, 0], - [:NEWLINE, "\n", 5, 0], - [:TEXT, 'l1', 2, 1], - [:NEWLINE, "\n", 4, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_label_newline_windows - str = <<-STR -[cat]\r - l1\r - STR - - expected = [ - [:LABEL, 'cat', 0, 0], - [:NEWLINE, "\n", 6, 0], - [:TEXT, 'l1', 2, 1], - [:NEWLINE, "\n", 5, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_lalpha - str = <<-STR -a. l1 -b. l1.1 - STR - - expected = [ - [:LALPHA, 'a', 0, 0], - [:TEXT, 'l1', 3, 0], - [:NEWLINE, "\n", 5, 0], - [:LALPHA, 'b', 0, 1], - [:TEXT, 'l1.1', 3, 1], - [:NEWLINE, "\n", 7, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_line_break - str = "now is\nthe time \nfor all\n" - - expected = [ - [:TEXT, 'now is', 0, 0], - [:NEWLINE, "\n", 6, 0], - [:TEXT, 'the time', 0, 1], - [:BREAK, " ", 8, 1], - [:NEWLINE, "\n", 10, 1], - [:TEXT, 'for all', 0, 2], - [:NEWLINE, "\n", 7, 2], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_line_break_long - str = "now is\nthe time \nfor all\n" - - expected = [ - [:TEXT, 'now is', 0, 0], - [:NEWLINE, "\n", 6, 0], - [:TEXT, 'the time ', 0, 1], - [:BREAK, ' ', 9, 1], - [:NEWLINE, "\n", 11, 1], - [:TEXT, 'for all', 0, 2], - [:NEWLINE, "\n", 7, 2], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_line_break_no_short - str = "now is\nthe time \nfor all\n" - - expected = [ - [:TEXT, 'now is', 0, 0], - [:NEWLINE, "\n", 6, 0], - [:TEXT, 'the time ', 0, 1], - [:NEWLINE, "\n", 9, 1], - [:TEXT, 'for all', 0, 2], - [:NEWLINE, "\n", 7, 2], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_note - str = <<-STR -cat:: l1 -dog:: l1.1 - STR - - expected = [ - [:NOTE, 'cat', 0, 0], - [:TEXT, 'l1', 6, 0], - [:NEWLINE, "\n", 8, 0], - [:NOTE, 'dog', 0, 1], - [:TEXT, 'l1.1', 6, 1], - [:NEWLINE, "\n", 10, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_note_empty - str = <<-STR -cat:: -dog:: - STR - - expected = [ - [:NOTE, 'cat', 0, 0], - [:NEWLINE, "\n", 5, 0], - [:NOTE, 'dog', 0, 1], - [:NEWLINE, "\n", 5, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_note_newline - str = <<-STR -cat:: - l1 - STR - - expected = [ - [:NOTE, 'cat', 0, 0], - [:NEWLINE, "\n", 5, 0], - [:TEXT, 'l1', 2, 1], - [:NEWLINE, "\n", 4, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_note_utf_8 - str = <<-STR -cät:: l1a - l1b -døg:: l2a - l2b - STR - - expected = [ - [:NOTE, 'cät', 0, 0], - [:TEXT, 'l1a', 6, 0], - [:NEWLINE, "\n", 9, 0], - [:TEXT, 'l1b', 6, 1], - [:NEWLINE, "\n", 9, 1], - [:NOTE, 'døg', 0, 2], - [:TEXT, 'l2a', 6, 2], - [:NEWLINE, "\n", 9, 2], - [:TEXT, 'l2b', 6, 3], - [:NEWLINE, "\n", 9, 3], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_note_newline_windows - str = <<-STR -cat::\r - l1\r - STR - - expected = [ - [:NOTE, 'cat', 0, 0], - [:NEWLINE, "\n", 6, 0], - [:TEXT, 'l1', 2, 1], - [:NEWLINE, "\n", 5, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_note_not - str = <<-STR -Cat::Dog - STR - - expected = [ - [:TEXT, 'Cat::Dog', 0, 0], - [:NEWLINE, "\n", 8, 0], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_number - str = <<-STR -1. l1 -2. l1.1 - STR - - expected = [ - [:NUMBER, '1', 0, 0], - [:TEXT, 'l1', 3, 0], - [:NEWLINE, "\n", 5, 0], - [:NUMBER, '2', 0, 1], - [:TEXT, 'l1.1', 3, 1], - [:NEWLINE, "\n", 7, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_number_period - str = <<-STR -1. blah blah blah - l. -2. blah blah blah blah - d. - STR - - expected = [ - [:NUMBER, "1", 0, 0], - [:TEXT, "blah blah blah", 3, 0], - [:NEWLINE, "\n", 17, 0], - - [:TEXT, "l.", 3, 1], - [:NEWLINE, "\n", 5, 1], - - [:NUMBER, "2", 0, 2], - [:TEXT, "blah blah blah blah", 3, 2], - [:NEWLINE, "\n", 22, 2], - - [:TEXT, "d.", 3, 3], - [:NEWLINE, "\n", 5, 3] - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_number_period_continue - str = <<-STR -1. blah blah blah - l. more stuff -2. blah blah blah blah - d. other stuff - STR - - expected = [ - [:NUMBER, "1", 0, 0], - [:TEXT, "blah blah blah", 3, 0], - [:NEWLINE, "\n", 17, 0], - - [:LALPHA, "l", 3, 1], - [:TEXT, "more stuff", 7, 1], - [:NEWLINE, "\n", 17, 1], - - [:NUMBER, "2", 0, 2], - [:TEXT, "blah blah blah blah", 3, 2], - [:NEWLINE, "\n", 22, 2], - - [:LALPHA, "d", 3, 3], - [:TEXT, "other stuff", 6, 3], - [:NEWLINE, "\n", 17, 3] - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_paragraphs - str = <<-STR -now is -the time - -for all - STR - - expected = [ - [:TEXT, 'now is', 0, 0], - [:NEWLINE, "\n", 6, 0], - [:TEXT, 'the time', 0, 1], - [:NEWLINE, "\n", 8, 1], - [:NEWLINE, "\n", 0, 2], - [:TEXT, 'for all', 0, 3], - [:NEWLINE, "\n", 7, 3], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_rule - str = <<-STR ---- - ---- blah --- - STR - - expected = [ - [:RULE, 1, 0, 0], - [:NEWLINE, "\n", 3, 0], - [:NEWLINE, "\n", 0, 1], - [:TEXT, "--- blah ---", 0, 2], - [:NEWLINE, "\n", 12, 2], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_rule_windows - str = <<-STR ----\r - ---- blah ---\r - STR - - expected = [ - [:RULE, 1, 0, 0], - [:NEWLINE, "\n", 4, 0], - [:NEWLINE, "\n", 0, 1], - [:TEXT, "--- blah ---", 0, 2], - [:NEWLINE, "\n", 13, 2], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_ualpha - str = <<-STR -A. l1 -B. l1.1 - STR - - expected = [ - [:UALPHA, 'A', 0, 0], - [:TEXT, 'l1', 3, 0], - [:NEWLINE, "\n", 5, 0], - [:UALPHA, 'B', 0, 1], - [:TEXT, 'l1.1', 3, 1], - [:NEWLINE, "\n", 7, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_verbatim_heading - str = <<-STR -Example heading: - - === heading three - STR - - expected = [ - [:TEXT, 'Example heading:', 0, 0], - [:NEWLINE, "\n", 16, 0], - [:NEWLINE, "\n", 0, 1], - [:HEADER, 3, 3, 2], - [:TEXT, 'heading three', 7, 2], - [:NEWLINE, "\n", 20, 2], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_verbatim_rule - str = <<-STR - Verbatim section here that is double-underlined - =============================================== - STR - - expected = [ - [:TEXT, 'Verbatim section here that is double-underlined', 2, 0], - [:NEWLINE, "\n", 49, 0], - [:HEADER, 47, 2, 1], - [:NEWLINE, "\n", 49, 1], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - def test_tokenize_verbatim_rule_fancy - str = <<-STR - A - b - =============================================== - c - STR - - expected = [ - [:TEXT, 'A', 2, 0], - [:NEWLINE, "\n", 3, 0], - [:TEXT, 'b', 4, 1], - [:NEWLINE, "\n", 5, 1], - [:HEADER, 47, 2, 2], - [:NEWLINE, "\n", 49, 2], - [:TEXT, 'c', 4, 3], - [:NEWLINE, "\n", 5, 3], - ] - - assert_equal expected, @RMP.tokenize(str) - end - - # HACK move to Verbatim test case - def test_verbatim_normalize - v = @RM::Verbatim.new "foo\n", "\n", "\n", "bar\n" - - v.normalize - - assert_equal ["foo\n", "\n", "bar\n"], v.parts - - v = @RM::Verbatim.new "foo\n", "\n" - - v.normalize - - assert_equal ["foo\n"], v.parts - end - - def test_unget - parser = util_parser - - parser.get - - parser.unget - - assert_equal [:HEADER, 1, 0, 0], parser.peek_token - - assert_raise @RMP::Error do - parser.unget - end - - assert_equal 8, parser.tokens.length - end - - def util_parser - str = <<-STR -= Heading - -Some text here -some more text over here - STR - - @parser = @RMP.new - @parser.tokenize str - @parser - end - -end diff --git a/test/rdoc/test_rdoc_markup_pre_process.rb b/test/rdoc/test_rdoc_markup_pre_process.rb deleted file mode 100644 index 2a8cd92dd0..0000000000 --- a/test/rdoc/test_rdoc_markup_pre_process.rb +++ /dev/null @@ -1,481 +0,0 @@ -# frozen_string_literal: true - -require_relative 'helper' - -class RDoc::Markup::PreProcessTest < RDoc::TestCase - - def setup - super - - @tempfile = Tempfile.new 'test_rdoc_markup_pre_process' - @file_name = File.basename @tempfile.path - @dir = File.dirname @tempfile.path - - @pp = RDoc::Markup::PreProcess.new @tempfile.path, [@dir, File.dirname(__FILE__)] - end - - def teardown - super - - @tempfile.close! - end - - def test_class_register - RDoc::Markup::PreProcess.register 'for_test' do raise 'fail' end - - assert_equal %w[for_test], RDoc::Markup::PreProcess.registered.keys - end - - def test_class_post_process - RDoc::Markup::PreProcess.post_process do end - - assert_equal 1, RDoc::Markup::PreProcess.post_processors.length, - proc{RDoc::Markup::PreProcess.post_processors.inspect} - end - - def test_include_file - @tempfile.write <<-INCLUDE -# -*- mode: rdoc; coding: utf-8; fill-column: 74; -*- - -Regular expressions (<i>regexp</i>s) are patterns which describe the -contents of a string. - INCLUDE - - @tempfile.flush - @tempfile.rewind - - content = @pp.include_file @file_name, '', nil - - expected = <<-EXPECTED -Regular expressions (<i>regexp</i>s) are patterns which describe the -contents of a string. - EXPECTED - - assert_equal expected, content - end - - def test_include_file_encoding_incompatible - @tempfile.write <<-INCLUDE -# -*- mode: rdoc; coding: utf-8; fill-column: 74; -*- - -π - INCLUDE - - @tempfile.flush - @tempfile.rewind - - content = @pp.include_file @file_name, '', Encoding::US_ASCII - - expected = "?\n" - - assert_equal expected, content - end - - def test_include_file_in_other_directory - content = nil - out, err = capture_output do - content = @pp.include_file "test.txt", '', nil - end - - assert_empty out - assert_empty err - - assert_equal "test file\n", content - end - - def test_handle - text = "# :main: M\n" - output = nil - _, err = capture_output do - output = @pp.handle text - end - - assert_include err, "The :main: directive is deprecated and will be removed in RDoc 7." - assert_equal "#\n", output - end - - def test_handle_comment - text = "# :main: M\n" - c = comment text - - output = nil - _, err = capture_output do - output = @pp.handle c - end - - assert_include err, "The :main: directive is deprecated and will be removed in RDoc 7." - assert_equal "#\n", output - end - - def test_handle_markup - c = comment ':markup: rd' - - @pp.handle c - - assert_equal 'rd', c.format - end - - def test_handle_markup_empty - c = comment ':markup:' - - @pp.handle c - - assert_equal 'rdoc', c.format - end - - def test_handle_post_process - cd = RDoc::CodeObject.new - - RDoc::Markup::PreProcess.post_process do |text, code_object| - code_object.metadata[:stuff] = text - - :junk - end - - text = "# a b c\n" - - out = @pp.handle text, cd - - assert_equal "# a b c\n", out - assert_equal "# a b c\n", cd.metadata[:stuff] - end - - def test_handle_unregistered - text = "# :x: y\n" - out = @pp.handle text - - assert_equal text, out - end - - def test_handle_directive_blankline - result = @pp.handle_directive '#', 'arg', 'a, b' - - assert_equal "#:arg: a, b\n", result - end - - def test_handle_directive_downcase - method = RDoc::AnyMethod.new nil, 'm' - - @pp.handle_directive '', 'ARG', 'a, b', method - - assert_equal 'a, b', method.params - end - - def test_handle_directive_arg - method = RDoc::AnyMethod.new nil, 'm' - - @pp.handle_directive '', 'arg', 'a, b', method - - assert_equal 'a, b', method.params - end - - def test_handle_directive_arg_no_context - result = @pp.handle_directive '', 'arg', 'a, b', nil - - assert_equal ":arg: a, b\n", result - end - - def test_handle_directive_args - method = RDoc::AnyMethod.new nil, 'm' - - @pp.handle_directive '', 'args', 'a, b', method - - assert_equal 'a, b', method.params - end - - def test_handle_directive_block - result = @pp.handle_directive '', 'x', 'y' do |directive, param| - '' - end - - assert_empty result - end - - def test_handle_directive_block_false - result = @pp.handle_directive '', 'x', 'y' do |directive, param| - false - end - - assert_equal ":x: y\n", result - end - - def test_handle_directive_block_nil - result = @pp.handle_directive '', 'x', 'y' do |directive, param| - nil - end - - assert_equal ":x: y\n", result - end - - def test_handle_directive_category - context = RDoc::Context.new - original_section = context.current_section - - @pp.handle_directive '', 'category', 'other', context - - refute_equal original_section, context.current_section - end - - def test_handle_directive_doc - code_object = RDoc::CodeObject.new - code_object.document_self = false - code_object.force_documentation = false - - @pp.handle_directive '', 'doc', nil, code_object - - assert code_object.document_self - assert code_object.force_documentation - end - - def test_handle_directive_doc_no_context - result = @pp.handle_directive '', 'doc', nil - - assert_equal "\n", result - end - - def test_handle_directive_enddoc - code_object = RDoc::CodeObject.new - - @pp.handle_directive '', 'enddoc', nil, code_object - - assert code_object.done_documenting - end - - def test_handle_directive_include - @tempfile.write 'included' - @tempfile.flush - - result = @pp.handle_directive '', 'include', @file_name - - assert_equal 'included', result - end - - def test_handle_directive_main - @pp.options = RDoc::Options.new - - _, err = capture_output do - @pp.handle_directive '', 'main', 'M' - end - - assert_include err, "The :main: directive is deprecated and will be removed in RDoc 7." - assert_equal 'M', @pp.options.main_page - end - - def test_handle_directive_notnew - m = RDoc::AnyMethod.new nil, 'm' - - @pp.handle_directive '', 'notnew', nil, m - - assert m.dont_rename_initialize - end - - def test_handle_directive_not_new - m = RDoc::AnyMethod.new nil, 'm' - - @pp.handle_directive '', 'not_new', nil, m - - assert m.dont_rename_initialize - end - - def test_handle_directive_not_dash_new - m = RDoc::AnyMethod.new nil, 'm' - - @pp.handle_directive '', 'not-new', nil, m - - assert m.dont_rename_initialize - end - - def test_handle_directive_nodoc - code_object = RDoc::CodeObject.new - code_object.document_self = true - code_object.document_children = true - - @pp.handle_directive '', 'nodoc', nil, code_object - - refute code_object.document_self - assert code_object.document_children - end - - def test_handle_directive_nodoc_all - code_object = RDoc::CodeObject.new - code_object.document_self = true - code_object.document_children = true - - @pp.handle_directive '', 'nodoc', 'all', code_object - - refute code_object.document_self - refute code_object.document_children - end - - def test_handle_directive_nodoc_no_context - result = @pp.handle_directive '', 'nodoc', nil - - assert_equal "\n", result - end - - def test_handle_directive_registered - RDoc::Markup::PreProcess.register 'x' - - result = @pp.handle_directive '', 'x', 'y' - - assert_nil result - - result = @pp.handle_directive '', 'x', 'y' do |directive, param| - false - end - - assert_equal ":x: y\n", result - - result = @pp.handle_directive '', 'x', 'y' do |directive, param| - '' - end - - assert_equal '', result - end - - def test_handle_directive_registered_block - called = nil - - RDoc::Markup::PreProcess.register 'x' do |directive, param| - called = [directive, param] - 'blah' - end - - result = @pp.handle_directive '', 'x', 'y' - - assert_equal 'blah', result - assert_equal %w[x y], called - end - - def test_handle_directive_registered_code_object - RDoc::Markup::PreProcess.register 'x' - code_object = RDoc::CodeObject.new - - @pp.handle_directive '', 'x', 'y', code_object - - assert_equal 'y', code_object.metadata['x'] - - code_object.metadata.clear - - result = @pp.handle_directive '', 'x', 'y' do |directive, param| - false - end - - assert_equal ":x: y\n", result - assert_empty code_object.metadata - - result = @pp.handle_directive '', 'x', 'y' do |directive, param| - '' - end - - assert_equal '', result - assert_empty code_object.metadata - end - - def test_handle_directive_startdoc - code_object = RDoc::CodeObject.new - code_object.stop_doc - code_object.force_documentation = false - - @pp.handle_directive '', 'startdoc', nil, code_object - - assert code_object.document_self - assert code_object.document_children - assert code_object.force_documentation - end - - def test_handle_directive_stopdoc - code_object = RDoc::CodeObject.new - - @pp.handle_directive '', 'stopdoc', nil, code_object - - refute code_object.document_self - refute code_object.document_children - end - - def test_handle_directive_title - @pp.options = RDoc::Options.new - - _, err = capture_output do - @pp.handle_directive '', 'title', 'T' - end - - assert_include err, "The :title: directive is deprecated and will be removed in RDoc 7." - assert_equal 'T', @pp.options.title - end - - def test_handle_directive_unhandled - code_object = RDoc::CodeObject.new - - @pp.handle_directive '', 'x', 'y', code_object - - assert_equal 'y', code_object.metadata['x'] - - code_object.metadata.clear - - @pp.handle_directive '', 'x', '', code_object - - assert_includes code_object.metadata, 'x' - end - - def test_handle_directive_unhandled_block - code_object = RDoc::CodeObject.new - - @pp.handle_directive '', 'x', 'y', code_object do - false - end - - assert_empty code_object.metadata - - @pp.handle_directive '', 'x', 'y', code_object do - nil - end - - assert_equal 'y', code_object.metadata['x'] - - code_object.metadata.clear - - @pp.handle_directive '', 'x', 'y', code_object do - '' - end - - assert_empty code_object.metadata - end - - def test_handle_directive_yield - method = RDoc::AnyMethod.new nil, 'm' - method.params = 'index, &block' - - @pp.handle_directive '', 'yield', 'item', method - - assert_equal 'item', method.block_params - assert_equal 'index', method.params - end - - def test_handle_directive_yield_block_param - method = RDoc::AnyMethod.new nil, 'm' - method.params = '&block' - - @pp.handle_directive '', 'yield', 'item', method - - assert_equal 'item', method.block_params - assert_empty method.params - end - - def test_handle_directive_yield_no_context - method = RDoc::AnyMethod.new nil, 'm' - - @pp.handle_directive '', 'yield', 'item', method - - assert_equal 'item', method.block_params - end - - def test_handle_directive_yields - method = RDoc::AnyMethod.new nil, 'm' - - @pp.handle_directive '', 'yields', 'item', method - - assert_equal 'item', method.block_params - end - -end diff --git a/test/rdoc/test_rdoc_markup_raw.rb b/test/rdoc/test_rdoc_markup_raw.rb deleted file mode 100644 index 52887e6f6c..0000000000 --- a/test/rdoc/test_rdoc_markup_raw.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupRaw < RDoc::TestCase - - def setup - super - - @p = @RM::Raw.new - end - - def test_push - @p.push 'hi', 'there' - - assert_equal @RM::Raw.new('hi', 'there'), @p - end - - def test_pretty_print - assert_equal '[raw: ]', mu_pp(@p) - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_ansi.rb b/test/rdoc/test_rdoc_markup_to_ansi.rb deleted file mode 100644 index 020f546997..0000000000 --- a/test/rdoc/test_rdoc_markup_to_ansi.rb +++ /dev/null @@ -1,380 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class RDocMarkupToAnsiTest < RDoc::Markup::TextFormatterTestCase - - add_visitor_tests - add_text_tests - - def setup - super - - @to = RDoc::Markup::ToAnsi.new - end - - def accept_blank_line - assert_equal "\e[0m\n", @to.res.join - end - - def accept_block_quote - assert_equal "\e[0m> quote\n", @to.res.join - end - - def accept_document - assert_equal "\e[0mhello\n", @to.res.join - end - - def accept_heading - assert_equal "\e[0mHello\n", @to.res.join - end - - def accept_list_end_bullet - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_label - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_lalpha - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_note - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_number - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_ualpha - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_item_end_bullet - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_label - assert_equal "\e[0mcat:\n", @to.res.join - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_lalpha - assert_equal 0, @to.indent, 'indent' - assert_equal 'b', @to.list_index.last - end - - def accept_list_item_end_note - assert_equal "\e[0mcat:\n", @to.res.join - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_number - assert_equal 0, @to.indent, 'indent' - assert_equal 2, @to.list_index.last - end - - def accept_list_item_end_ualpha - assert_equal 0, @to.indent, 'indent' - assert_equal 'B', @to.list_index.last - end - - def accept_list_item_start_bullet - assert_equal %W"\e[0m", @to.res - assert_equal '* ', @to.prefix - end - - def accept_list_item_start_label - assert_equal %W"\e[0m", @to.res - assert_equal "cat:\n ", @to.prefix - - assert_equal 2, @to.indent - end - - def accept_list_item_start_lalpha - assert_equal %W"\e[0m", @to.res - assert_equal 'a. ', @to.prefix - - assert_equal 'a', @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_item_start_note - assert_equal %W"\e[0m", @to.res - assert_equal "cat:\n ", @to.prefix - - assert_equal 2, @to.indent - end - - def accept_list_item_start_number - assert_equal %W"\e[0m", @to.res - assert_equal '1. ', @to.prefix - - assert_equal 1, @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_item_start_ualpha - assert_equal %W"\e[0m", @to.res - assert_equal 'A. ', @to.prefix - - assert_equal 'A', @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_start_bullet - assert_equal "\e[0m", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:BULLET], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_label - assert_equal "\e[0m", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:LABEL], @to.list_type - assert_equal [2], @to.list_width - end - - def accept_list_start_lalpha - assert_equal "\e[0m", @to.res.join - assert_equal ['a'], @to.list_index - assert_equal [:LALPHA], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_note - assert_equal "\e[0m", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:NOTE], @to.list_type - assert_equal [2], @to.list_width - end - - def accept_list_start_number - assert_equal "\e[0m", @to.res.join - assert_equal [1], @to.list_index - assert_equal [:NUMBER], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_ualpha - assert_equal "\e[0m", @to.res.join - assert_equal ['A'], @to.list_index - assert_equal [:UALPHA], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_paragraph - assert_equal "\e[0mhi\n", @to.res.join - end - - def accept_raw - raw = <<-RAW.rstrip -\e[0m<table> -<tr><th>Name<th>Count -<tr><td>a<td>1 -<tr><td>b<td>2 -</table> - RAW - - assert_equal raw, @to.res.join - end - - def accept_rule - assert_equal "\e[0m#{'-' * 78}\n", @to.res.join - end - - def accept_verbatim - assert_equal "\e[0m hi\n world\n\n", @to.res.join - end - - def end_accepting - assert_equal "\e[0mhi", @to.end_accepting - end - - def start_accepting - assert_equal 0, @to.indent - assert_equal %W"\e[0m", @to.res - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_heading_1 - assert_equal "\e[0m\e[1;32mHello\e[m\n", @to.end_accepting - end - - def accept_heading_2 - assert_equal "\e[0m\e[4;32mHello\e[m\n", @to.end_accepting - end - - def accept_heading_3 - assert_equal "\e[0m\e[32mHello\e[m\n", @to.end_accepting - end - - def accept_heading_4 - assert_equal "\e[0mHello\n", @to.end_accepting - end - - def accept_heading_indent - assert_equal "\e[0m \e[1;32mHello\e[m\n", @to.end_accepting - end - - def accept_heading_b - assert_equal "\e[0m\e[1;32m\e[1mHello\e[m\e[m\n", @to.end_accepting - end - - def accept_heading_suppressed_crossref - assert_equal "\e[0m\e[1;32mHello\e[m\n", @to.end_accepting - end - - def accept_list_item_start_note_2 - assert_equal "\e[0m\e[7mteletype\e[m:\n teletype description\n\n", - @to.res.join - end - - def accept_list_item_start_note_multi_description - assert_equal "\e[0mlabel:\n description one\n\n description two\n\n", - @to.res.join - end - - def accept_list_item_start_note_multi_label - assert_equal "\e[0mone\ntwo:\n two headers\n\n", - @to.res.join - end - - def accept_paragraph_b - assert_equal "\e[0mreg \e[1mbold words\e[m reg\n", @to.end_accepting - end - - def accept_paragraph_br - assert_equal "\e[0mone\ntwo\n", @to.end_accepting - end - - def accept_paragraph_break - assert_equal "\e[0mhello\nworld\n", @to.end_accepting - end - - def accept_paragraph_i - assert_equal "\e[0mreg \e[4mitalic words\e[m reg\n", @to.end_accepting - end - - def accept_paragraph_indent - expected = <<-EXPECTED -\e[0m words words words words words words words words words words words words - words words words words words words words words words words words words - words words words words words words - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_paragraph_plus - assert_equal "\e[0mreg \e[7mteletype\e[m reg\n", @to.end_accepting - end - - def accept_paragraph_star - assert_equal "\e[0mreg \e[1mbold\e[m reg\n", @to.end_accepting - end - - def accept_paragraph_underscore - assert_equal "\e[0mreg \e[4mitalic\e[m reg\n", @to.end_accepting - end - - def accept_paragraph_wrap - expected = <<-EXPECTED -\e[0mwords words words words words words words words words words words words words -words words words words words words words words words words words words words -words words words words - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_rule_indent - assert_equal "\e[0m #{'-' * 75}\n", @to.end_accepting - end - - def accept_verbatim_indent - assert_equal "\e[0m hi\n world\n\n", @to.end_accepting - end - - def accept_verbatim_big_indent - assert_equal "\e[0m hi\n world\n\n", @to.end_accepting - end - - def list_nested - expected = <<-EXPECTED -\e[0m* l1 - * l1.1 -* l2 - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def list_verbatim - expected = <<-EXPECTED # HACK overblown -\e[0m* list stuff - - * list - with - - second - - 1. indented - 2. numbered - - third - - * second - - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_table_align - expected = "\e[0m" + <<-EXPECTED - AA |BB |CCCCC|DDDDD -----|---|-----|----- - |bbb| c| -aaaa|b | | dd - a | | cc| dd - EXPECTED - assert_equal expected, @to.end_accepting - end - - # functional test - def test_convert_list_note - note_list = <<-NOTE_LIST -foo :: -bar :: - hi - NOTE_LIST - - expected = <<-EXPECTED -\e[0mfoo -bar: - hi - - EXPECTED - - assert_equal expected, @to.convert(note_list) - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_bs.rb b/test/rdoc/test_rdoc_markup_to_bs.rb deleted file mode 100644 index d89d784422..0000000000 --- a/test/rdoc/test_rdoc_markup_to_bs.rb +++ /dev/null @@ -1,363 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class RDocMarkupToBsTest < RDoc::Markup::TextFormatterTestCase - - add_visitor_tests - add_text_tests - - def setup - super - - @to = RDoc::Markup::ToBs.new - end - - def accept_blank_line - assert_equal "\n", @to.res.join - end - - def accept_block_quote - assert_equal "> quote\n", @to.res.join - end - - def accept_document - assert_equal "hello\n", @to.res.join - end - - def accept_heading - assert_equal "===== H\bHe\bel\bll\blo\bo\n", @to.res.join - end - - def accept_list_end_bullet - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_label - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_lalpha - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_note - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_number - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_ualpha - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_item_end_bullet - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_label - assert_equal "cat:\n", @to.res.join - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_lalpha - assert_equal 0, @to.indent, 'indent' - assert_equal 'b', @to.list_index.last - end - - def accept_list_item_end_note - assert_equal "cat:\n", @to.res.join - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_number - assert_equal 0, @to.indent, 'indent' - assert_equal 2, @to.list_index.last - end - - def accept_list_item_end_ualpha - assert_equal 0, @to.indent, 'indent' - assert_equal 'B', @to.list_index.last - end - - def accept_list_item_start_bullet - assert_equal [''], @to.res - assert_equal '* ', @to.prefix - end - - def accept_list_item_start_label - assert_equal [''], @to.res - assert_equal "cat:\n ", @to.prefix - - assert_equal 2, @to.indent - end - - def accept_list_item_start_lalpha - assert_equal [''], @to.res - assert_equal 'a. ', @to.prefix - - assert_equal 'a', @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_item_start_note - assert_equal [''], @to.res - assert_equal "cat:\n ", @to.prefix - - assert_equal 2, @to.indent - end - - def accept_list_item_start_number - assert_equal [''], @to.res - assert_equal '1. ', @to.prefix - - assert_equal 1, @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_item_start_ualpha - assert_equal [''], @to.res - assert_equal 'A. ', @to.prefix - - assert_equal 'A', @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_start_bullet - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:BULLET], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_label - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:LABEL], @to.list_type - assert_equal [2], @to.list_width - end - - def accept_list_start_lalpha - assert_equal "", @to.res.join - assert_equal ['a'], @to.list_index - assert_equal [:LALPHA], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_note - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:NOTE], @to.list_type - assert_equal [2], @to.list_width - end - - def accept_list_start_number - assert_equal "", @to.res.join - assert_equal [1], @to.list_index - assert_equal [:NUMBER], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_ualpha - assert_equal "", @to.res.join - assert_equal ['A'], @to.list_index - assert_equal [:UALPHA], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_paragraph - assert_equal "hi\n", @to.res.join - end - - def accept_raw - raw = <<-RAW.rstrip -<table> -<tr><th>Name<th>Count -<tr><td>a<td>1 -<tr><td>b<td>2 -</table> - RAW - - assert_equal raw, @to.res.join - end - - def accept_rule - assert_equal "#{'-' * 78}\n", @to.res.join - end - - def accept_verbatim - assert_equal " hi\n world\n\n", @to.res.join - end - - def end_accepting - assert_equal "hi", @to.end_accepting - end - - def start_accepting - assert_equal 0, @to.indent - assert_equal [''], @to.res - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_heading_1 - assert_equal "= H\bHe\bel\bll\blo\bo\n", @to.end_accepting - end - - def accept_heading_2 - assert_equal "== H\bHe\bel\bll\blo\bo\n", @to.end_accepting - end - - def accept_heading_3 - assert_equal "=== H\bHe\bel\bll\blo\bo\n", @to.end_accepting - end - - def accept_heading_4 - assert_equal "==== H\bHe\bel\bll\blo\bo\n", @to.end_accepting - end - - def accept_heading_indent - assert_equal " = H\bHe\bel\bll\blo\bo\n", @to.end_accepting - end - - def accept_heading_b - assert_equal "= H\bHe\bel\bll\blo\bo\n", @to.end_accepting - end - - def accept_heading_suppressed_crossref - assert_equal "= H\bHe\bel\bll\blo\bo\n", @to.end_accepting - end - - def accept_list_item_start_note_2 - assert_equal "teletype:\n teletype description\n\n", @to.res.join - end - - def accept_list_item_start_note_multi_description - assert_equal "label:\n description one\n\n description two\n\n", - @to.res.join - end - - def accept_list_item_start_note_multi_label - assert_equal "one\ntwo:\n two headers\n\n", @to.res.join - end - - def accept_paragraph_b - assert_equal "reg b\bbo\bol\bld\bd \b w\bwo\bor\brd\bds\bs reg\n", - @to.end_accepting - end - - def accept_paragraph_br - assert_equal "one\ntwo\n", @to.end_accepting - end - - def accept_paragraph_break - assert_equal "hello\nworld\n", - @to.end_accepting - end - - def accept_paragraph_i - assert_equal "reg _\bi_\bt_\ba_\bl_\bi_\bc_\b _\bw_\bo_\br_\bd_\bs reg\n", - @to.end_accepting - end - - def accept_paragraph_indent - expected = <<-EXPECTED - words words words words words words words words words words words words - words words words words words words words words words words words words - words words words words words words - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_paragraph_plus - assert_equal "reg teletype reg\n", @to.end_accepting - end - - def accept_paragraph_star - assert_equal "reg b\bbo\bol\bld\bd reg\n", @to.end_accepting - end - - def accept_paragraph_underscore - assert_equal "reg _\bi_\bt_\ba_\bl_\bi_\bc reg\n", @to.end_accepting - end - - def accept_paragraph_wrap - expected = <<-EXPECTED -words words words words words words words words words words words words words -words words words words words words words words words words words words words -words words words words - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_rule_indent - assert_equal " #{'-' * 75}\n", @to.end_accepting - end - - def accept_verbatim_indent - assert_equal " hi\n world\n\n", @to.end_accepting - end - - def accept_verbatim_big_indent - assert_equal " hi\n world\n\n", @to.end_accepting - end - - def list_nested - expected = <<-EXPECTED -* l1 - * l1.1 -* l2 - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def list_verbatim - expected = <<-EXPECTED # HACK overblown -* list stuff - - * list - with - - second - - 1. indented - 2. numbered - - third - - * second - - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_table_align - expected = <<-EXPECTED - AA |BB |CCCCC|DDDDD -----|---|-----|----- - |bbb| c| -aaaa|b | | dd - a | | cc| dd - EXPECTED - assert_equal expected, @to.end_accepting - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_html.rb b/test/rdoc/test_rdoc_markup_to_html.rb deleted file mode 100644 index ffd16f0837..0000000000 --- a/test/rdoc/test_rdoc_markup_to_html.rb +++ /dev/null @@ -1,994 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class RDocMarkupToHtmlTest < RDoc::Markup::FormatterTestCase - - add_visitor_tests - - def setup - super - - @to = RDoc::Markup::ToHtml.new @options - end - - def accept_blank_line - assert_empty @to.res.join - end - - def accept_block_quote - assert_equal "\n<blockquote>\n<p>quote</p>\n</blockquote>\n", @to.res.join - end - - def accept_document - assert_equal "\n<p>hello</p>\n", @to.res.join - end - - def accept_heading - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - expected = "\n<h5 id=\"label-Hello\">Hello#{links}</h5>\n" - - assert_equal expected, @to.res.join - end - - def accept_heading_1 - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", @to.res.join - end - - def accept_heading_2 - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h2 id=\"label-Hello\">Hello#{links}</h2>\n", @to.res.join - end - - def accept_heading_3 - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h3 id=\"label-Hello\">Hello#{links}</h3>\n", @to.res.join - end - - def accept_heading_4 - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h4 id=\"label-Hello\">Hello#{links}</h4>\n", @to.res.join - end - - def accept_heading_b - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - inner = "<strong>Hello</strong>" - - assert_equal "\n<h1 id=\"label-Hello\">#{inner}#{links}</h1>\n", - @to.res.join - end - - def accept_heading_suppressed_crossref - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", @to.res.join - end - - def accept_list_end_bullet - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "<ul></ul>\n", @to.res.join - end - - def accept_list_end_label - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "<dl class=\"rdoc-list label-list\"></dl>\n", @to.res.join - end - - def accept_list_end_lalpha - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "<ol style=\"list-style-type: lower-alpha\"></ol>\n", @to.res.join - end - - def accept_list_end_number - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "<ol></ol>\n", @to.res.join - end - - def accept_list_end_note - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "<dl class=\"rdoc-list note-list\"></dl>\n", @to.res.join - end - - def accept_list_end_ualpha - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "<ol style=\"list-style-type: upper-alpha\"></ol>\n", @to.res.join - end - - def accept_list_item_end_bullet - assert_equal %w[</li>], @to.in_list_entry - end - - def accept_list_item_end_label - assert_equal %w[</dd>], @to.in_list_entry - end - - def accept_list_item_end_lalpha - assert_equal %w[</li>], @to.in_list_entry - end - - def accept_list_item_end_note - assert_equal %w[</dd>], @to.in_list_entry - end - - def accept_list_item_end_number - assert_equal %w[</li>], @to.in_list_entry - end - - def accept_list_item_end_ualpha - assert_equal %w[</li>], @to.in_list_entry - end - - def accept_list_item_start_bullet - assert_equal "<ul><li>", @to.res.join - end - - def accept_list_item_start_label - assert_equal "<dl class=\"rdoc-list label-list\"><dt>cat</dt>\n<dd>", @to.res.join - end - - def accept_list_item_start_lalpha - assert_equal "<ol style=\"list-style-type: lower-alpha\"><li>", @to.res.join - end - - def accept_list_item_start_note - assert_equal "<dl class=\"rdoc-list note-list\"><dt>cat</dt>\n<dd>", - @to.res.join - end - - def accept_list_item_start_note_2 - expected = <<-EXPECTED -<dl class="rdoc-list note-list"><dt><code>teletype</code></dt> -<dd> -<p>teletype description</p> -</dd></dl> - EXPECTED - - assert_equal expected, @to.res.join - end - - def accept_list_item_start_note_multi_description - expected = <<-EXPECTED -<dl class="rdoc-list note-list"><dt>label</dt> -<dd> -<p>description one</p> -</dd><dd> -<p>description two</p> -</dd></dl> - EXPECTED - - assert_equal expected, @to.res.join - end - - def accept_list_item_start_note_multi_label - expected = <<-EXPECTED -<dl class="rdoc-list note-list"><dt>one</dt> -<dt>two</dt> -<dd> -<p>two headers</p> -</dd></dl> - EXPECTED - - assert_equal expected, @to.res.join - end - - def accept_list_item_start_number - assert_equal "<ol><li>", @to.res.join - end - - def accept_list_item_start_ualpha - assert_equal "<ol style=\"list-style-type: upper-alpha\"><li>", @to.res.join - end - - def accept_list_start_bullet - assert_equal [:BULLET], @to.list - assert_equal [false], @to.in_list_entry - - assert_equal "<ul>", @to.res.join - end - - def accept_list_start_label - assert_equal [:LABEL], @to.list - assert_equal [false], @to.in_list_entry - - assert_equal '<dl class="rdoc-list label-list">', @to.res.join - end - - def accept_list_start_lalpha - assert_equal [:LALPHA], @to.list - assert_equal [false], @to.in_list_entry - - assert_equal "<ol style=\"list-style-type: lower-alpha\">", @to.res.join - end - - def accept_list_start_note - assert_equal [:NOTE], @to.list - assert_equal [false], @to.in_list_entry - - assert_equal "<dl class=\"rdoc-list note-list\">", @to.res.join - end - - def accept_list_start_number - assert_equal [:NUMBER], @to.list - assert_equal [false], @to.in_list_entry - - assert_equal "<ol>", @to.res.join - end - - def accept_list_start_ualpha - assert_equal [:UALPHA], @to.list - assert_equal [false], @to.in_list_entry - - assert_equal "<ol style=\"list-style-type: upper-alpha\">", @to.res.join - end - - def accept_paragraph - assert_equal "\n<p>hi</p>\n", @to.res.join - end - - def accept_paragraph_b - assert_equal "\n<p>reg <strong>bold words</strong> reg</p>\n", @to.res.join - end - - def accept_paragraph_br - assert_equal "\n<p>one<br>two</p>\n", @to.res.join - end - - def accept_paragraph_break - assert_equal "\n<p>hello<br> world</p>\n", @to.res.join - end - - def accept_paragraph_i - assert_equal "\n<p>reg <em>italic words</em> reg</p>\n", @to.res.join - end - - def accept_paragraph_plus - assert_equal "\n<p>reg <code>teletype</code> reg</p>\n", @to.res.join - end - - def accept_paragraph_star - assert_equal "\n<p>reg <strong>bold</strong> reg</p>\n", @to.res.join - end - - def accept_paragraph_underscore - assert_equal "\n<p>reg <em>italic</em> reg</p>\n", @to.res.join - end - - def accept_raw - raw = <<-RAW.rstrip -<table> -<tr><th>Name<th>Count -<tr><td>a<td>1 -<tr><td>b<td>2 -</table> - RAW - - assert_equal raw, @to.res.join - end - - def accept_rule - assert_equal "<hr>\n", @to.res.join - end - - def accept_verbatim - assert_equal "\n<pre class=\"ruby\"><span class=\"ruby-identifier\">hi</span>\n <span class=\"ruby-identifier\">world</span>\n</pre>\n", @to.res.join - end - - def end_accepting - assert_equal 'hi', @to.end_accepting - end - - def start_accepting - assert_equal [], @to.res - assert_equal [], @to.in_list_entry - assert_equal [], @to.list - end - - def list_nested - expected = <<-EXPECTED -<ul><li> -<p>l1</p> -<ul><li> -<p>l1.1</p> -</li></ul> -</li><li> -<p>l2</p> -</li></ul> - EXPECTED - - assert_equal expected, @to.res.join - end - - def list_verbatim - expected = <<-EXPECTED -<ul><li> -<p>list stuff</p> - -<pre>* list - with - - second - - 1. indented - 2. numbered - - third - -* second</pre> -</li></ul> - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def test_accept_heading_7 - @to.start_accepting - - @to.accept_heading @RM::Heading.new(7, 'Hello') - - links = '<span><a href="#label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h6 id=\"label-Hello\">Hello#{links}</h6>\n", @to.res.join - end - - def test_accept_heading_aref_class - @to.code_object = RDoc::NormalClass.new 'Foo' - @to.start_accepting - - @to.accept_heading head(1, 'Hello') - - links = '<span><a href="#class-Foo-label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h1 id=\"class-Foo-label-Hello\">Hello#{links}</h1>\n", - @to.res.join - end - - def test_accept_heading_aref_method - @to.code_object = RDoc::AnyMethod.new nil, 'foo' - @to.start_accepting - - @to.accept_heading @RM::Heading.new(1, 'Hello') - - links = '<span><a href="#method-i-foo-label-Hello">¶</a> ' + - '<a href="#top">↑</a></span>' - - assert_equal "\n<h1 id=\"method-i-foo-label-Hello\">Hello#{links}</h1>\n", - @to.res.join - end - - def test_accept_heading_pipe - @options.pipe = true - - @to.start_accepting - - @to.accept_heading @RM::Heading.new(1, 'Hello') - - assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n", @to.res.join - end - - def test_accept_paragraph_newline - hellos = ["hello", "\u{393 3b5 3b9 3ac} \u{3c3 3bf 3c5}"] - worlds = ["world", "\u{3ba 3cc 3c3 3bc 3bf 3c2}"] - ohayo, sekai = %W"\u{304a 306f 3088 3046} \u{4e16 754c}" - - hellos.product(worlds) do |hello, world| - @to.start_accepting - @to.accept_paragraph para("#{hello}\n", "#{world}\n") - assert_equal "\n<p>#{hello} #{world}</p>\n", @to.res.join - end - - hellos.each do |hello| - @to.start_accepting - @to.accept_paragraph para("#{hello}\n", "#{sekai}\n") - assert_equal "\n<p>#{hello}#{sekai}</p>\n", @to.res.join - end - - worlds.each do |world| - @to.start_accepting - @to.accept_paragraph para("#{ohayo}\n", "#{world}\n") - assert_equal "\n<p>#{ohayo}#{world}</p>\n", @to.res.join - end - - @to.start_accepting - @to.accept_paragraph para("#{ohayo}\n", "#{sekai}\n") - assert_equal "\n<p>#{ohayo}#{sekai}</p>\n", @to.res.join - - @to.start_accepting - @to.accept_paragraph para("+hello+\n", "world\n") - assert_equal "\n<p><code>hello</code> world</p>\n", @to.res.join - - @to.start_accepting - @to.accept_paragraph para("hello\n", "+world+\n") - assert_equal "\n<p>hello <code>world</code></p>\n", @to.res.join - - @to.start_accepting - @to.accept_paragraph para("+hello+\n", "+world+\n") - assert_equal "\n<p><code>hello</code> <code>world</code></p>\n", @to.res.join - end - - def test_accept_heading_output_decoration - @options.output_decoration = false - - @to.start_accepting - - @to.accept_heading @RM::Heading.new(1, 'Hello') - - assert_equal "\n<h1>Hello<span><a href=\"#label-Hello\">¶</a> <a href=\"#top\">↑</a></span></h1>\n", @to.res.join - end - - def test_accept_heading_output_decoration_with_pipe - @options.pipe = true - @options.output_decoration = false - - @to.start_accepting - - @to.accept_heading @RM::Heading.new(1, 'Hello') - - assert_equal "\n<h1>Hello</h1>\n", @to.res.join - end - - def test_accept_verbatim_parseable - verb = @RM::Verbatim.new("class C\n", "end\n") - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-EXPECTED - -<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">C</span> -<span class="ruby-keyword">end</span> -</pre> - EXPECTED - - assert_equal expected, @to.res.join - end - - def test_accept_verbatim_parseable_error - verb = @RM::Verbatim.new("a % 09 # => blah\n") - - @to.start_accepting - @to.accept_verbatim verb - - inner = CGI.escapeHTML "a % 09 # => blah" - - expected = <<-EXPECTED - -<pre>#{inner}</pre> - EXPECTED - - assert_equal expected, @to.res.join - end - - def test_accept_verbatim_nl_after_backslash - verb = @RM::Verbatim.new("a = 1 if first_flag_var and \\\n", " this_is_flag_var\n") - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-EXPECTED - -<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">first_flag_var</span> <span class="ruby-keyword">and</span> \\ - <span class="ruby-identifier">this_is_flag_var</span> -</pre> - EXPECTED - - assert_equal expected, @to.res.join - end - - def test_accept_verbatim_pipe - @options.pipe = true - - verb = @RM::Verbatim.new("1 + 1\n") - verb.format = :ruby - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-EXPECTED - -<pre><code>1 + 1 -</code></pre> - EXPECTED - - assert_equal expected, @to.res.join - end - - def test_accept_verbatim_escape_in_string - code = <<-'RUBY' -def foo - [ - '\\', - '\'', - "'", - "\'\"\`", - "\#", - "\#{}", - "#", - "#{}", - /'"/, - /\'\"/, - /\//, - /\\/, - /\#/, - /\#{}/, - /#/, - /#{}/ - ] -end -def bar -end - RUBY - verb = @RM::Verbatim.new(*code.split(/(?<=\n)/)) - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-'EXPECTED' - -<pre class="ruby"><span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span> - [ - <span class="ruby-string">'\\'</span>, - <span class="ruby-string">'\''</span>, - <span class="ruby-string">"'"</span>, - <span class="ruby-string">"\'\"\`"</span>, - <span class="ruby-string">"\#"</span>, - <span class="ruby-string">"\#{}"</span>, - <span class="ruby-string">"#"</span>, - <span class="ruby-node">"#{}"</span>, - <span class="ruby-regexp">/'"/</span>, - <span class="ruby-regexp">/\'\"/</span>, - <span class="ruby-regexp">/\//</span>, - <span class="ruby-regexp">/\\/</span>, - <span class="ruby-regexp">/\#/</span>, - <span class="ruby-regexp">/\#{}/</span>, - <span class="ruby-regexp">/#/</span>, - <span class="ruby-regexp">/#{}/</span> - ] -<span class="ruby-keyword">end</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bar</span> -<span class="ruby-keyword">end</span> -</pre> - EXPECTED - - assert_equal expected, @to.res.join - end - - def test_accept_verbatim_escape_in_backtick - code = <<-'RUBY' -def foo - [ - `\\`, - `\'\"\``, - `\#`, - `\#{}`, - `#`, - `#{}` - ] -end -def bar -end - RUBY - verb = @RM::Verbatim.new(*code.split(/(?<=\n)/)) - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-'EXPECTED' - -<pre class="ruby"><span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span> - [ - <span class="ruby-string">`\\`</span>, - <span class="ruby-string">`\'\"\``</span>, - <span class="ruby-string">`\#`</span>, - <span class="ruby-string">`\#{}`</span>, - <span class="ruby-string">`#`</span>, - <span class="ruby-node">`#{}`</span> - ] -<span class="ruby-keyword">end</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bar</span> -<span class="ruby-keyword">end</span> -</pre> - EXPECTED - - assert_equal expected, @to.res.join - end - - def test_accept_verbatim_ruby - verb = @RM::Verbatim.new("1 + 1\n") - verb.format = :ruby - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-EXPECTED - -<pre class="ruby"><span class="ruby-value">1</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span> -</pre> - EXPECTED - - assert_equal expected, @to.res.join - end - - def test_accept_verbatim_redefinable_operators - functions = %w[| ^ & <=> == === =~ > >= < <= << >> + - * / % ** ~ +@ -@ [] []= ` ! != !~].flat_map { |redefinable_op| - ["def #{redefinable_op}\n", "end\n"] - } - - verb = @RM::Verbatim.new(*functions) - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-EXPECTED - -<pre class="ruby"> - EXPECTED - expected = expected.rstrip - - %w[| ^ & <=> == === =~ > >= < <= << >> + - * / % ** ~ +@ -@ [] []= ` ! != !~].each do |html_escaped_op| - expected += <<-EXPECTED -<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">#{html_escaped_op}</span> -<span class="ruby-keyword">end</span> - EXPECTED - end - - expected += <<-EXPECTED -</pre> -EXPECTED - - assert_equal expected, @to.res.join - end - - def test_convert_string - assert_equal '<>', @to.convert_string('<>') - end - - def test_convert_HYPERLINK_irc - result = @to.convert 'irc://irc.freenode.net/#ruby-lang' - - assert_equal "\n<p><a href=\"irc://irc.freenode.net/#ruby-lang\">irc.freenode.net/#ruby-lang</a></p>\n", result - end - - def test_convert_RDOCLINK_label_label - result = @to.convert 'rdoc-label:label-One' - - assert_equal "\n<p><a href=\"#label-One\">One</a></p>\n", result - end - - def test_convert_RDOCLINK_label_foottext - result = @to.convert 'rdoc-label:foottext-1' - - assert_equal "\n<p><a href=\"#foottext-1\">1</a></p>\n", result - end - - def test_convert_RDOCLINK_label_footmark - result = @to.convert 'rdoc-label:footmark-1' - - assert_equal "\n<p><a href=\"#footmark-1\">1</a></p>\n", result - end - - def test_convert_RDOCLINK_ref - result = @to.convert 'rdoc-ref:C' - - assert_equal "\n<p>C</p>\n", result - end - - def test_convert_RDOCLINK_escape_image - assert_escaped '<script>', 'rdoc-image:"><script>alert(`rdoc-image`)</script>"' - end - - def test_convert_RDOCLINK_escape_label_id - assert_escaped '<script>', 'rdoc-label::path::"><script>alert(`rdoc-label_id`)</script>"' - end - - def test_convert_RDOCLINK_escape_label_path - assert_escaped '<script>', 'rdoc-label::"><script>alert(`rdoc-label_path`)</script>"' - end - - def test_convert_RDOCLINK_escape_ref - assert_escaped '<script>', 'rdoc-ref:"><script>alert(`rdoc-ref`)</script>"' - end - - def test_convert_RDOCLINK_escape_xxx - assert_escaped '<script>', 'rdoc-xxx:"><script>alert(`rdoc-xxx`)</script>"' - end - - def test_convert_TIDYLINK_footnote - result = @to.convert 'text{*1}[rdoc-label:foottext-1:footmark-1]' - - assert_equal "\n<p>text<sup><a id=\"footmark-1\" href=\"#foottext-1\">1</a></sup></p>\n", result - end - - def test_convert_TIDYLINK_multiple - result = @to.convert '{a}[http://example] {b}[http://example]' - - expected = <<-EXPECTED - -<p><a href=\"http://example\">a</a> <a href=\"http://example\">b</a></p> - EXPECTED - - assert_equal expected, result - end - - def test_convert_TIDYLINK_image - result = - @to.convert '{rdoc-image:path/to/image.jpg}[http://example.com]' - - expected = - "\n<p><a href=\"http://example.com\"><img src=\"path/to/image.jpg\"></a></p>\n" - - assert_equal expected, result - - result = - @to.convert '{rdoc-image:<script>alert`link text`</script>}[http://example.com]' - - assert_not_include result, "<script>" - end - - def test_convert_TIDYLINK_rdoc_label - result = @to.convert '{foo}[rdoc-label:foottext-1]' - - assert_equal "\n<p><a href=\"#foottext-1\">foo</a></p>\n", result - end - - def test_convert_TIDYLINK_irc - result = @to.convert '{ruby-lang}[irc://irc.freenode.net/#ruby-lang]' - - assert_equal "\n<p><a href=\"irc://irc.freenode.net/#ruby-lang\">ruby-lang</a></p>\n", result - end - - def test_convert_TIDYLINK_escape_text - assert_escaped '<script>', '{<script>alert`link text`</script>}[a]' - assert_escaped '<script>', 'x:/<script>alert(1);</script>[[]' - end - - def test_convert_TIDYLINK_escape_javascript - assert_not_include '{click}[javascript:alert`javascript_scheme`]', '<a href="javascript:' - end - - def test_convert_TIDYLINK_escape_onmouseover - assert_escaped '"/onmouseover="', '{onmouseover}[http://"/onmouseover="alert`on_mouse_link`"]' - end - - def test_convert_TIDYLINK_escape_onerror - assert_escaped '"onerror="', '{link_image}[http://"onerror="alert`link_image`".png]' - end - - def test_convert_with_exclude_tag - assert_equal "\n<p><code>aaa</code>[:symbol]</p>\n", @to.convert('+aaa+[:symbol]') - assert_equal "\n<p><code>aaa[:symbol]</code></p>\n", @to.convert('+aaa[:symbol]+') - assert_equal "\n<p><code>https:</code>-foobar</p>\n", @to.convert('<tt>https:</tt>-foobar') - assert_equal "\n<p><a href=\":symbol\">aaa</a></p>\n", @to.convert('aaa[:symbol]') - end - - def test_convert_underscore_adjacent_to_code - assert_equal "\n<p><code>aaa</code>_</p>\n", @to.convert(%q{+aaa+_}) - assert_equal "\n<p>\u{2018}<code>i386-mswin32_</code><em>MSRTVERSION</em>\u{2019}</p>\n", @to.convert(%q{`+i386-mswin32_+_MSRTVERSION_'}) - end - - def test_gen_url - assert_equal '<a href="example">example</a>', - @to.gen_url('link:example', 'example') - end - - def test_gen_url_rdoc_label - assert_equal '<a href="#foottext-1">example</a>', - @to.gen_url('rdoc-label:foottext-1', 'example') - end - - def test_gen_url_rdoc_label_id - assert_equal '<sup><a id="footmark-1" href="#foottext-1">example</a></sup>', - @to.gen_url('rdoc-label:foottext-1:footmark-1', 'example') - end - - def test_gen_url_image_url - assert_equal '<img src="http://example.com/image.png" />', @to.gen_url('http://example.com/image.png', 'ignored') - end - - def test_gen_url_ssl_image_url - assert_equal '<img src="https://example.com/image.png" />', @to.gen_url('https://example.com/image.png', 'ignored') - end - - def test_gen_url_rdoc_file - assert_equal '<a href="example_rdoc.html">example</a>', - @to.gen_url('example.rdoc', 'example') - assert_equal '<a href="doc/example_rdoc.html">example</a>', - @to.gen_url('doc/example.rdoc', 'example') - assert_equal '<a href="../ex.doc/example_rdoc.html">example</a>', - @to.gen_url('../ex.doc/example.rdoc', 'example') - assert_equal '<a href="doc/example_rdoc.html#label-one">example</a>', - @to.gen_url('doc/example.rdoc#label-one', 'example') - assert_equal '<a href="../ex.doc/example_rdoc.html#label-two">example</a>', - @to.gen_url('../ex.doc/example.rdoc#label-two', 'example') - end - - def test_gen_url_md_file - assert_equal '<a href="example_md.html">example</a>', - @to.gen_url('example.md', 'example') - assert_equal '<a href="doc/example_md.html">example</a>', - @to.gen_url('doc/example.md', 'example') - assert_equal '<a href="../ex.doc/example_md.html">example</a>', - @to.gen_url('../ex.doc/example.md', 'example') - assert_equal '<a href="doc/example_md.html#label-one">example</a>', - @to.gen_url('doc/example.md#label-one', 'example') - assert_equal '<a href="../ex.doc/example_md.html#label-two">example</a>', - @to.gen_url('../ex.doc/example.md#label-two', 'example') - end - - def test_gen_url_rb_file - assert_equal '<a href="example_rb.html">example</a>', - @to.gen_url('example.rb', 'example') - assert_equal '<a href="doc/example_rb.html">example</a>', - @to.gen_url('doc/example.rb', 'example') - assert_equal '<a href="../ex.doc/example_rb.html">example</a>', - @to.gen_url('../ex.doc/example.rb', 'example') - assert_equal '<a href="doc/example_rb.html#label-one">example</a>', - @to.gen_url('doc/example.rb#label-one', 'example') - assert_equal '<a href="../ex.doc/example_rb.html#label-two">example</a>', - @to.gen_url('../ex.doc/example.rb#label-two', 'example') - end - - def test_handle_regexp_HYPERLINK_link - target = RDoc::Markup::RegexpHandling.new 0, 'link:README.txt' - - link = @to.handle_regexp_HYPERLINK target - - assert_equal '<a href="README.txt">README.txt</a>', link - end - - def test_handle_regexp_HYPERLINK_irc - target = RDoc::Markup::RegexpHandling.new 0, 'irc://irc.freenode.net/#ruby-lang' - - link = @to.handle_regexp_HYPERLINK target - - assert_equal '<a href="irc://irc.freenode.net/#ruby-lang">irc.freenode.net/#ruby-lang</a>', link - end - - def test_handle_regexp_HYPERLINK_escape - code = 'irc://irc.freenode.net/"><script>alert(`irc`)</script><a"' - assert_escaped '<script>', code - end - - def test_list_verbatim_2 - str = "* one\n verb1\n verb2\n* two\n" - - expected = <<-EXPECTED -<ul><li> -<p>one</p> - -<pre class=\"ruby\"><span class=\"ruby-identifier\">verb1</span> -<span class=\"ruby-identifier\">verb2</span> -</pre> -</li><li> -<p>two</p> -</li></ul> - EXPECTED - - assert_equal expected, @m.convert(str, @to) - end - - def test_block_quote_in_verbatim - str = "BlockQuote\n >>>\n" - - expected = <<-EXPECTED -<p>BlockQuote</p> -<pre>>>></pre> - EXPECTED - - assert_equal expected, @m.convert(str, @to).gsub(/^\n/, "") - - str = "BlockQuote\n >>> word\n" - - expected = <<-EXPECTED -<p>BlockQuote</p> -<pre>>>> word</pre> - EXPECTED - - assert_equal expected, @m.convert(str, @to).gsub(/^\n/, "") - end - - def test_parseable_eh - valid_syntax = [ - 'def x() end', - 'def x; end', - 'class C; end', - "module M end", - 'a # => blah', - 'x { |y| nil }', - 'x do |y| nil end', - '# only a comment', - 'require "foo"', - 'cls="foo"' - ] - invalid_syntax = [ - 'def x end', - 'class C < end', - 'module M < C end', - 'a=># blah', - 'x { |y| ... }', - 'x do |y| ... end', - '// only a comment', - '<% require "foo" %>', - 'class="foo"' - ] - valid_syntax.each do |t| - assert @to.parseable?(t), "valid syntax considered invalid: #{t}" - end - invalid_syntax.each do |t| - refute @to.parseable?(t), "invalid syntax considered valid: #{t}" - end - end - - def test_to_html - assert_equal "\n<p><code>--</code></p>\n", util_format("<tt>--</tt>") - end - - def util_format text - paragraph = RDoc::Markup::Paragraph.new text - - @to.start_accepting - @to.accept_paragraph paragraph - @to.end_accepting - end - - def test_accept_table - header = %w[Col1 Col2 Col3 Col4] - body = [ - %w[cell1_1 cell1_2 cell1_3 cell1_4], - %w[cell2_1 cell2_2 cell2_3 cell2_4], - ['<script>alert("foo");</script>'], - %w[+code+ _em_ **strong** C1], - ] - aligns = [:left, :right, nil, :center] - @to.start_accepting - @to.accept_table(header, body, aligns) - res = @to.end_accepting - assert_include(res[%r<<th[^<>]*>Col1</th>>], 'align="left"') - assert_include(res[%r<<th[^<>]*>Col2</th>>], 'align="right"') - assert_not_include(res[%r<<th[^<>]*>Col3</th>>], 'align=') - assert_include(res[%r<<th[^<>]*>Col4</th>>], 'align="center"') - assert_include(res[%r<<td[^<>]*>cell1_1</td>>], 'align="left"') - assert_include(res[%r<<td[^<>]*>cell1_2</td>>], 'align="right"') - assert_not_include(res[%r<<td[^<>]*>cell1_3</td>>], 'align=') - assert_include(res[%r<<td[^<>]*>cell2_1</td>>], 'align="left"') - assert_include(res[%r<<td[^<>]*>cell2_2</td>>], 'align="right"') - assert_not_include(res[%r<<td[^<>]*>cell2_3</td>>], 'align=') - assert_include(res[%r<<td[^<>]*>cell2_4</td>>], 'align="center"') - assert_not_include(res, '<script>') - assert_include(res[%r<<td[^<>]*>.*script.*</td>>], '<script>') - assert_include(res[%r<<td[^<>]*>.*code.*</td>>], '<code>code</code>') - assert_include(res[%r<<td[^<>]*>.*em.*</td>>], '<em>em</em>') - assert_include(res[%r<<td[^<>]*>.*strong.*</td>>], '<strong>strong</strong>') - assert_include(res[%r<<td[^<>]*>C1</td>>], 'C1') - end - - def assert_escaped(unexpected, code) - result = @to.convert(code) - assert_not_include result, unexpected - assert_include result, CGI.escapeHTML(unexpected) - end -end diff --git a/test/rdoc/test_rdoc_markup_to_html_crossref.rb b/test/rdoc/test_rdoc_markup_to_html_crossref.rb deleted file mode 100644 index 5826f3d095..0000000000 --- a/test/rdoc/test_rdoc_markup_to_html_crossref.rb +++ /dev/null @@ -1,328 +0,0 @@ -# frozen_string_literal: true -require_relative 'xref_test_case' - -class RDocMarkupToHtmlCrossrefTest < XrefTestCase - - def setup - super - - @options.hyperlink_all = true - @options.warn_missing_rdoc_ref = true - - @to = RDoc::Markup::ToHtmlCrossref.new @options, 'index.html', @c1 - end - - def test_convert_CROSSREF - result = @to.convert 'C1' - - assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result - - result = @to.convert '+C1+' - assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result - - result = @to.convert 'Constant[rdoc-ref:C1]' - assert_equal para("<a href=\"C1.html\">Constant</a>"), result - - result = @to.convert 'FOO' - assert_equal para("FOO"), result - - result = @to.convert '+FOO+' - assert_equal para("<code>FOO</code>"), result - - result = @to.convert '<tt># :stopdoc:</tt>:' - assert_equal para("<code># :stopdoc:</code>:"), result - end - - def test_convert_CROSSREF_ignored_excluded_words - @options.autolink_excluded_words = ['C1'] - - result = @to.convert 'C1' - assert_equal para("C1"), result - - result = @to.convert '+C1+' - assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result - - # Explicit linking with rdoc-ref is not ignored - result = @to.convert 'Constant[rdoc-ref:C1]' - assert_equal para("<a href=\"C1.html\">Constant</a>"), result - end - - def test_convert_CROSSREF_method - result = @to.convert 'C1#m(foo, bar, baz)' - - assert_equal para("<a href=\"C1.html#method-i-m\"><code>C1#m(foo, bar, baz)</code></a>"), result - end - - def test_convert_CROSSREF_label - result = @to.convert 'C1@foo' - assert_equal para("<a href=\"C1.html#class-C1-label-foo\">foo at <code>C1</code></a>"), result - - result = @to.convert 'C1#m@foo' - assert_equal para("<a href=\"C1.html#method-i-m-label-foo\">foo at <code>C1#m</code></a>"), - result - end - - def test_convert_CROSSREF_label_for_md - result = @to.convert 'EXAMPLE@foo' - assert_equal para("<a href=\"EXAMPLE_md.html#label-foo\">foo at <code>EXAMPLE</code></a>"), result - end - - def test_convert_CROSSREF_label_period - result = @to.convert 'C1@foo.' - assert_equal para("<a href=\"C1.html#class-C1-label-foo\">foo at <code>C1</code></a>."), result - end - - def test_convert_CROSSREF_label_space - result = @to.convert 'C1@foo+bar' - assert_equal para("<a href=\"C1.html#class-C1-label-foo+bar\">foo bar at <code>C1</code></a>"), - result - end - - def test_convert_CROSSREF_section - @c1.add_section 'Section' - - result = @to.convert 'C1@Section' - assert_equal para("<a href=\"C1.html#Section\">Section at <code>C1</code></a>"), result - end - - def test_convert_CROSSREF_constant - result = @to.convert 'C1::CONST' - - assert_equal para("<a href=\"C1.html#CONST\"><code>C1::CONST</code></a>"), result - end - - def test_convert_RDOCLINK_rdoc_ref - result = @to.convert 'rdoc-ref:C1' - - assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result - end - - def test_convert_RDOCLINK_rdoc_ref_not_found - result = nil - stdout, _ = capture_output do - result = @to.convert 'rdoc-ref:FOO' - end - - assert_equal para("FOO"), result - assert_include stdout, "index.html: `rdoc-ref:FOO` can't be resolved for `FOO`" - end - - def test_convert_RDOCLINK_rdoc_ref_method - result = @to.convert 'rdoc-ref:C1#m' - - assert_equal para("<a href=\"C1.html#method-i-m\"><code>C1#m</code></a>"), result - end - - def test_convert_RDOCLINK_rdoc_ref_method_label - result = @to.convert 'rdoc-ref:C1#m@foo' - - assert_equal para("<a href=\"C1.html#method-i-m-label-foo\">foo at <code>C1#m</code></a>"), - result, 'rdoc-ref:C1#m@foo' - end - - def test_convert_RDOCLINK_rdoc_ref_method_percent - m = @c1.add_method RDoc::AnyMethod.new nil, '%' - m.singleton = false - - result = @to.convert 'rdoc-ref:C1#%' - - assert_equal para("<a href=\"C1.html#method-i-25\"><code>C1#%</code></a>"), result - - m.singleton = true - - result = @to.convert 'rdoc-ref:C1::%' - - assert_equal para("<a href=\"C1.html#method-c-25\"><code>C1::%</code></a>"), result - end - - def test_convert_RDOCLINK_rdoc_ref_method_escape_html - m = @c1.add_method RDoc::AnyMethod.new nil, '<<' - m.singleton = false - - result = @to.convert 'rdoc-ref:C1#<<' - - assert_equal para("<a href=\"C1.html#method-i-3C-3C\"><code>C1#<<</code></a>"), result - m.singleton = true - - result = @to.convert 'rdoc-ref:C1::<<' - - assert_equal para("<a href=\"C1.html#method-c-3C-3C\"><code>C1::<<</code></a>"), result - end - - def test_convert_RDOCLINK_rdoc_ref_method_percent_label - m = @c1.add_method RDoc::AnyMethod.new nil, '%' - m.singleton = false - - result = @to.convert 'rdoc-ref:C1#%@f' - - assert_equal para("<a href=\"C1.html#method-i-25-label-f\">f at <code>C1#%</code></a>"), - result - - m.singleton = true - - result = @to.convert 'rdoc-ref:C1::%@f' - - assert_equal para("<a href=\"C1.html#method-c-25-label-f\">f at <code>C1::%</code></a>"), - result - end - - def test_convert_RDOCLINK_rdoc_ref_label - result = @to.convert 'rdoc-ref:C1@foo' - - assert_equal para("<a href=\"C1.html#class-C1-label-foo\">foo at <code>C1</code></a>"), result, - 'rdoc-ref:C1@foo' - end - - def test_convert_RDOCLINK_rdoc_ref_label_in_current_file - result = @to.convert 'rdoc-ref:@foo' - - assert_equal para("<a href=\"#label-foo\">foo</a>"), result, - 'rdoc-ref:@foo' - - result = @to.convert '{Foo}[rdoc-ref:@foo]' - - assert_equal para("<a href=\"#label-foo\">Foo</a>"), result, - '{Foo}[rdoc-ref:@foo]' - end - - def test_gen_url - assert_equal '<a href="C1.html">Some class</a>', - @to.gen_url('rdoc-ref:C1', 'Some class') - - assert_equal '<a href="http://example">HTTP example</a>', - @to.gen_url('http://example', 'HTTP example') - end - - def test_gen_url_rdoc_ref_not_found - stdout, _ = capture_output do - @to.gen_url 'rdoc-ref:FOO', 'FOO' - end - - assert_include stdout, "index.html: `rdoc-ref:FOO` can't be resolved for `FOO`" - end - - def test_handle_regexp_CROSSREF - assert_equal "<a href=\"C2/C3.html\"><code>C2::C3</code></a>", REGEXP_HANDLING('C2::C3') - end - - def test_handle_regexp_CROSSREF_label - assert_equal "<a href=\"C1.html#method-i-m-label-foo\">foo at <code>C1#m</code></a>", - REGEXP_HANDLING('C1#m@foo') - end - - def test_handle_regexp_CROSSREF_show_hash_false - @to.show_hash = false - - assert_equal "<a href=\"C1.html#method-i-m\"><code>m</code></a>", - REGEXP_HANDLING('#m') - end - - def test_handle_regexp_CROSSREF_with_arg_looks_like_TIDYLINK - result = @to.convert 'C1.m[:sym]' - - assert_equal para("<a href=\"C1.html#method-c-m\"><code>C1.m[:sym]</code></a>"), result, - 'C1.m[:sym]' - end - - def test_handle_regexp_HYPERLINK_rdoc - readme = @store.add_file 'README.txt' - readme.parser = RDoc::Parser::Simple - - @to = RDoc::Markup::ToHtmlCrossref.new @options, 'C2.html', @c2 - - link = @to.handle_regexp_HYPERLINK hyper 'C2::C3' - - assert_equal '<a href="C2/C3.html"><code>C2::C3</code></a>', link - - link = @to.handle_regexp_HYPERLINK hyper 'C4' - - assert_equal '<a href="C4.html"><code>C4</code></a>', link - - link = @to.handle_regexp_HYPERLINK hyper 'README.txt' - - assert_equal '<a href="README_txt.html">README.txt</a>', link - end - - def test_handle_regexp_TIDYLINK_rdoc - readme = @store.add_file 'README.txt' - readme.parser = RDoc::Parser::Simple - - @to = RDoc::Markup::ToHtmlCrossref.new @options, 'C2.html', @c2 - - link = @to.handle_regexp_TIDYLINK tidy 'C2::C3' - - assert_equal '<a href="C2/C3.html">tidy</a>', link - - link = @to.handle_regexp_TIDYLINK tidy 'C4' - - assert_equal '<a href="C4.html">tidy</a>', link - - link = @to.handle_regexp_TIDYLINK tidy 'C1#m' - - assert_equal '<a href="C1.html#method-i-m">tidy</a>', link - - link = @to.handle_regexp_TIDYLINK tidy 'README.txt' - - assert_equal '<a href="README_txt.html">tidy</a>', link - end - - def test_handle_regexp_TIDYLINK_label - link = @to.handle_regexp_TIDYLINK tidy 'C1#m@foo' - - assert_equal "<a href=\"C1.html#method-i-m-label-foo\">tidy</a>", - link, 'C1#m@foo' - end - - def test_to_html_CROSSREF_email - @options.hyperlink_all = false - - @to = RDoc::Markup::ToHtmlCrossref.new @options, 'index.html', @c1 - - result = @to.to_html 'first.last@example.com' - - assert_equal 'first.last@example.com', result - end - - def test_to_html_CROSSREF_email_hyperlink_all - result = @to.to_html 'first.last@example.com' - - assert_equal 'first.last@example.com', result - end - - def test_link - assert_equal 'n', @to.link('n', 'n') - - assert_equal '<a href="C1.html#method-c-m"><code>m</code></a>', @to.link('m', 'm') - end - - def test_link_for_method_traverse - @to = RDoc::Markup::ToHtmlCrossref.new @options, 'C2.html', @c9 - assert_equal '<a href="C9/A.html#method-i-foo"><code>C9::B#foo</code></a>', @to.link('C9::B#foo', 'C9::B#foo') - end - - def test_link_class_method_full - assert_equal '<a href="Parent.html#method-c-m"><code>Parent::m</code></a>', - @to.link('Parent::m', 'Parent::m') - end - - def para text - "\n<p>#{text}</p>\n" - end - - def REGEXP_HANDLING text - @to.handle_regexp_CROSSREF regexp_handling text - end - - def hyper reference - RDoc::Markup::RegexpHandling.new 0, "rdoc-ref:#{reference}" - end - - def regexp_handling text - RDoc::Markup::RegexpHandling.new 0, text - end - - def tidy reference - RDoc::Markup::RegexpHandling.new 0, "{tidy}[rdoc-ref:#{reference}]" - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_html_snippet.rb b/test/rdoc/test_rdoc_markup_to_html_snippet.rb deleted file mode 100644 index 94f58b6529..0000000000 --- a/test/rdoc/test_rdoc_markup_to_html_snippet.rb +++ /dev/null @@ -1,709 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase - - add_visitor_tests - - def setup - super - - @to = RDoc::Markup::ToHtmlSnippet.new @options, 100, 100 - @ellipsis = @to.to_html '...' - end - - def accept_blank_line - assert_empty @to.res.join - end - - def accept_block_quote - assert_equal "\n<blockquote><p>quote\n</blockquote>\n", @to.res.join - - assert_equal 5, @to.characters - end - - def accept_document - assert_equal "<p>hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_1 - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_2 - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_3 - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_4 - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_b - assert_equal "<p><strong>Hello</strong>\n", - @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_suppressed_crossref - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_list_end_bullet - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_label - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_lalpha - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_number - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_note - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_ualpha - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_item_end_bullet - assert_equal [''], @to.in_list_entry - assert_equal 0, @to.characters - end - - def accept_list_item_end_label - assert_equal [''], @to.in_list_entry - assert_equal 4, @to.characters - end - - def accept_list_item_end_lalpha - assert_equal [''], @to.in_list_entry - assert_equal 0, @to.characters - end - - def accept_list_item_end_note - assert_equal [''], @to.in_list_entry - assert_equal 4, @to.characters - end - - def accept_list_item_end_number - assert_equal [''], @to.in_list_entry - assert_equal 0, @to.characters - end - - def accept_list_item_end_ualpha - assert_equal [''], @to.in_list_entry - assert_equal 0, @to.characters - end - - def accept_list_item_start_bullet - assert_equal "<p>", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_item_start_label - assert_equal "<p>cat — ", @to.res.join - assert_equal 4, @to.characters - end - - def accept_list_item_start_lalpha - assert_equal "<p>", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_item_start_note - assert_equal "<p>cat — ", - @to.res.join - assert_equal 4, @to.characters - end - - def accept_list_item_start_note_2 - expected = <<-EXPECTED -<p><code>teletype</code> — teletype description - - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 29, @to.characters - end - - def accept_list_item_start_note_multi_description - expected = <<-EXPECTED -<p>label — description one -<p>description two - - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 37, @to.characters - end - - def accept_list_item_start_note_multi_label - expected = <<-EXPECTED -<p>one, two — two headers - - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 18, @to.characters - end - - def accept_list_item_start_number - assert_equal "<p>", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_item_start_ualpha - assert_equal "<p>", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_bullet - assert_equal [:BULLET], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_label - assert_equal [:LABEL], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_lalpha - assert_equal [:LALPHA], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_note - assert_equal [:NOTE], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_number - assert_equal [:NUMBER], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_ualpha - assert_equal [:UALPHA], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_paragraph - assert_equal "<p>hi\n", @to.res.join - - assert_equal 2, @to.characters - end - - def accept_paragraph_b - assert_equal "<p>reg <strong>bold words</strong> reg\n", @to.res.join - - assert_equal 18, @to.characters - end - - def accept_paragraph_br - assert_equal "<p>one<br>two\n", @to.res.join - - assert_equal 6, @to.characters - end - - def accept_paragraph_break - assert_equal "<p>hello<br>\nworld\n", @to.res.join - - assert_equal 11, @to.characters - end - - def accept_paragraph_i - assert_equal "<p>reg <em>italic words</em> reg\n", @to.res.join - - assert_equal 20, @to.characters - end - - def accept_paragraph_plus - assert_equal "<p>reg <code>teletype</code> reg\n", @to.res.join - - assert_equal 16, @to.characters - end - - def accept_paragraph_star - assert_equal "<p>reg <strong>bold</strong> reg\n", @to.res.join - - assert_equal 12, @to.characters - end - - def accept_paragraph_underscore - assert_equal "<p>reg <em>italic</em> reg\n", @to.res.join - - assert_equal 14, @to.characters - end - - def accept_raw - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_rule - assert_empty @to.res - assert_equal 0, @to.characters - end - - def accept_verbatim - assert_equal "\n<pre class=\"ruby\"><span class=\"ruby-identifier\">hi</span>\n <span class=\"ruby-identifier\">world</span>\n</pre>\n", @to.res.join - assert_equal 10, @to.characters - end - - def end_accepting - assert_equal 'hi', @to.res.join - end - - def start_accepting - assert_equal [], @to.res - assert_equal [], @to.in_list_entry - assert_equal [], @to.list - assert_equal 0, @to.characters - end - - def list_nested - expected = <<-EXPECTED -<p>l1 -<p>l1.1 - -<p>l2 - - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 8, @to.characters - end - - def list_verbatim - expected = <<-EXPECTED -<p>list stuff - -<pre>* list - with - - second - - 1. indented - 2. numbered - - third - -* second</pre> - - EXPECTED - - assert_equal expected, @to.end_accepting - assert_equal 81, @to.characters - end - - def test_accept_heading_7 - @to.start_accepting - - @to.accept_heading @RM::Heading.new(7, 'Hello') - - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def test_accept_heading_aref_class - @to.code_object = RDoc::NormalClass.new 'Foo' - @to.start_accepting - - @to.accept_heading @RM::Heading.new(1, 'Hello') - - assert_equal "<p>Hello\n", - @to.res.join - assert_equal 5, @to.characters - end - - def test_accept_heading_aref_method - @to.code_object = RDoc::AnyMethod.new nil, 'foo' - @to.start_accepting - - @to.accept_heading @RM::Heading.new(1, 'Hello') - - assert_equal "<p>Hello\n", - @to.res.join - assert_equal 5, @to.characters - end - - def test_accept_verbatim_ruby - options = RDoc::Options.new - rdoc = RDoc::RDoc.new - rdoc.options = options - RDoc::RDoc.current = rdoc - - verb = @RM::Verbatim.new("class C\n", "end\n") - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-EXPECTED - -<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">C</span> -<span class="ruby-keyword">end</span> -</pre> - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 11, @to.characters - end - - def test_accept_verbatim_ruby_error - options = RDoc::Options.new - rdoc = RDoc::RDoc.new - rdoc.options = options - RDoc::RDoc.current = rdoc - - verb = @RM::Verbatim.new("a % 09 # => blah\n") - - @to.start_accepting - @to.accept_verbatim verb - - inner = CGI.escapeHTML "a % 09 # => blah" - - expected = <<-EXPECTED - -<pre>#{inner}</pre> - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 16, @to.characters - end - - def test_add_paragraph - @to = RDoc::Markup::ToHtmlSnippet.new @options, 0, 3 - assert_throws :done do - @to.add_paragraph - @to.add_paragraph - @to.add_paragraph - end - - assert_equal 3, @to.paragraphs - end - - def test_convert_limit - rdoc = <<-RDOC -= Hello - -This is some text, it *will* be cut off after 100 characters and an ellipsis -must follow - -So there you have it - RDOC - - expected = <<-EXPECTED -<p>Hello -<p>This is some text, it <strong>will</strong> be cut off after 100 characters and an ellipsis must follow -<p>So there you #{@ellipsis} - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 111, @to.characters, 'snippet character length' - end - - def test_convert_limit_2 - rdoc = <<-RDOC -Outputs formatted RI data for the class or method +name+. - -Returns true if +name+ was found, false if it was not an alternative could -be guessed, raises an error if +name+ couldn't be guessed. - RDOC - - expected = <<-EXPECTED -<p>Outputs formatted RI data for the class or method <code>name</code>. -<p>Returns true if <code>name</code> was found, false if it was #{@ellipsis} - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 159, @to.characters, 'snippet character length' - end - - def test_convert_limit_paragraphs - @to = RDoc::Markup::ToHtmlSnippet.new @options, 100, 3 - - rdoc = <<-RDOC -= \RDoc - Ruby Documentation System - -* {RDoc Project Page}[https://github.com/ruby/rdoc] -* {RDoc Documentation}[https://ruby.github.io/rdoc] -* {RDoc Bug Tracker}[https://github.com/ruby/rdoc/issues] - -== DESCRIPTION: - -RDoc produces HTML and command-line documentation for Ruby projects. RDoc -includes the +rdoc+ and +ri+ tools for generating and displaying online -documentation. - -See RDoc for a description of RDoc's markup and basic use. - RDOC - - expected = <<-EXPECTED -<p>RDoc - Ruby Documentation System -<p>RDoc Project Page -<p>RDoc Documentation - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 67, @to.characters - end - - def test_convert_limit_in_tag - @to = RDoc::Markup::ToHtmlSnippet.new @options, 4 - rdoc = "* ab *c* d\n" - - expected = "<p>ab <strong>c</strong> #{@ellipsis}\n\n" - - actual = @to.convert rdoc - - assert_equal 4, @to.characters - assert_equal expected, actual - end - - def test_convert_limit_verbatim - rdoc = <<-RDOC -= Hello There - -This is some text, it *will* be cut off after 100 characters - - This one is cut off in this verbatim section - RDOC - - expected = <<-EXPECTED -<p>Hello There -<p>This is some text, it <strong>will</strong> be cut off after 100 characters - -<pre>This one is cut off in this verbatim ...</pre> - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 113, @to.characters - end - - def test_convert_limit_verbatim_2 - rdoc = <<-RDOC -Extracts the class, selector and method name parts from +name+ like -Foo::Bar#baz. - -NOTE: Given Foo::Bar, Bar is considered a class even though it may be a - method - RDOC - - expected = <<-EXPECTED -<p>Extracts the class, selector and method name parts from <code>name</code> like Foo::Bar#baz. -<p>NOTE: Given Foo::Bar, #{@ellipsis} - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 101, @to.characters - end - - def test_convert_limit_verbatim_multiline - rdoc = <<-RDOC -Look for directives in a normal comment block: - - # :stopdoc: - # Don't display comment from this point forward - -This routine modifies its +comment+ parameter. - RDOC - - inner = CGI.escapeHTML "# Don't display comment from this point forward" - expected = <<-EXPECTED -<p>Look for directives in a normal comment block: - -<pre class=\"ruby\"><span class=\"ruby-comment\"># :stopdoc:</span> -<span class=\"ruby-comment\">#{inner}</span> -</pre> - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 105, @to.characters - end - - def test_convert_limit_over - @to = RDoc::Markup::ToHtmlSnippet.new @options, 4 - rdoc = "* text\n" * 2 - - expected = "<p>text\n" - expected = expected.chomp - expected << " #{@ellipsis}\n" - - actual = @to.convert rdoc - - assert_equal 4, @to.characters - assert_equal expected, actual - end - - def test_convert_string - assert_equal '<>', @to.convert_string('<>') - end - - def test_convert_RDOCLINK_label_label - result = @to.convert 'rdoc-label:label-One' - - assert_equal "<p>One\n", result - assert_equal 3, @to.characters - end - - def test_convert_RDOCLINK_label_foottext - result = @to.convert 'rdoc-label:foottext-1' - - assert_equal "<p>1\n", result - assert_equal 1, @to.characters - end - - def test_convert_RDOCLINK_label_footmark - result = @to.convert 'rdoc-label:footmark-1' - - assert_equal "<p>1\n", result - assert_equal 1, @to.characters - end - - def test_convert_RDOCLINK_ref - result = @to.convert 'rdoc-ref:C' - - assert_equal "<p>C\n", result - assert_equal 1, @to.characters - end - - def test_convert_TIDYLINK_rdoc_label - result = @to.convert '{foo}[rdoc-label:foottext-1]' - - assert_equal "<p>foo\n", result - assert_equal 3, @to.characters - end - - def test_handle_regexp_HYPERLINK_link - target = RDoc::Markup::RegexpHandling.new 0, 'link:README.txt' - - link = @to.handle_regexp_HYPERLINK target - - assert_equal 'README.txt', link - end - - def test_list_verbatim_2 - str = "* one\n verb1\n verb2\n* two\n" - - expected = <<-EXPECTED -<p>one - -<pre class=\"ruby\"><span class=\"ruby-identifier\">verb1</span> -<span class=\"ruby-identifier\">verb2</span> -</pre> -<p>two - - EXPECTED - - assert_equal expected, @m.convert(str, @to) - assert_equal 17, @to.characters - end - - def test_on_tags - on = RDoc::Markup::AttrChanger.new 2, 0 - - @to.on_tags [], on - - assert_equal 2, @to.mask - end - - def test_off_tags - on = RDoc::Markup::AttrChanger.new 2, 0 - off = RDoc::Markup::AttrChanger.new 0, 2 - - @to.on_tags [], on - @to.off_tags [], off - - assert_equal 0, @to.mask - end - - def test_to_html - assert_equal "<p><code>--</code>\n", util_format("<tt>--</tt>") - assert_equal 2, @to.characters - end - - def util_format text - paragraph = RDoc::Markup::Paragraph.new text - - @to.start_accepting - @to.accept_paragraph paragraph - @to.end_accepting - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_joined_paragraph.rb b/test/rdoc/test_rdoc_markup_to_joined_paragraph.rb deleted file mode 100644 index 8bd2d67247..0000000000 --- a/test/rdoc/test_rdoc_markup_to_joined_paragraph.rb +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupToJoinedParagraph < RDoc::TestCase - - def setup - super - - @to = RDoc::Markup::ToJoinedParagraph.new - end - - def test_accept_paragraph - parsed = para('hello', ' ', 'world') - - @to.accept_paragraph parsed - - expected = para('hello world') - - assert_equal expected, parsed - end - - def test_accept_paragraph_break - parsed = para('hello', ' ', 'world', hard_break, 'everyone') - - @to.accept_paragraph parsed - - expected = para('hello world', hard_break, 'everyone') - - assert_equal expected, parsed - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_label.rb b/test/rdoc/test_rdoc_markup_to_label.rb deleted file mode 100644 index 2bf2e0ecdf..0000000000 --- a/test/rdoc/test_rdoc_markup_to_label.rb +++ /dev/null @@ -1,112 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupToLabel < RDoc::Markup::FormatterTestCase - - add_visitor_tests - - def setup - super - - @to = RDoc::Markup::ToLabel.new - end - - def empty - assert_empty @to.res - end - - def end_accepting - assert_equal %w[hi], @to.res - end - - alias accept_blank_line empty - alias accept_block_quote empty - alias accept_document empty - alias accept_heading empty - alias accept_heading_1 empty - alias accept_heading_2 empty - alias accept_heading_3 empty - alias accept_heading_4 empty - alias accept_heading_b empty - alias accept_heading_suppressed_crossref empty - alias accept_list_end_bullet empty - alias accept_list_end_label empty - alias accept_list_end_lalpha empty - alias accept_list_end_note empty - alias accept_list_end_number empty - alias accept_list_end_ualpha empty - alias accept_list_item_end_bullet empty - alias accept_list_item_end_label empty - alias accept_list_item_end_lalpha empty - alias accept_list_item_end_note empty - alias accept_list_item_end_number empty - alias accept_list_item_end_ualpha empty - alias accept_list_item_start_bullet empty - alias accept_list_item_start_label empty - alias accept_list_item_start_lalpha empty - alias accept_list_item_start_note empty - alias accept_list_item_start_note_2 empty - alias accept_list_item_start_note_multi_description empty - alias accept_list_item_start_note_multi_label empty - alias accept_list_item_start_number empty - alias accept_list_item_start_ualpha empty - alias accept_list_start_bullet empty - alias accept_list_start_label empty - alias accept_list_start_lalpha empty - alias accept_list_start_note empty - alias accept_list_start_number empty - alias accept_list_start_ualpha empty - alias accept_paragraph empty - alias accept_paragraph_b empty - alias accept_paragraph_br empty - alias accept_paragraph_break empty - alias accept_paragraph_i empty - alias accept_paragraph_plus empty - alias accept_paragraph_star empty - alias accept_paragraph_underscore empty - alias accept_raw empty - alias accept_rule empty - alias accept_verbatim empty - alias list_nested empty - alias list_verbatim empty - alias start_accepting empty - - def test_convert_bold - assert_equal 'bold', @to.convert('<b>bold</b>') - assert_equal 'bold', @to.convert('*bold*') - end - - def test_convert_crossref - assert_equal 'SomeClass', @to.convert('SomeClass') - assert_equal 'SomeClass', @to.convert('\\SomeClass') - - assert_equal 'some_method', @to.convert('some_method') - assert_equal 'some_method', @to.convert('\\some_method') - - assert_equal '23some_method', @to.convert('#some_method') - assert_equal '23some_method', @to.convert('\\#some_method') - end - - def test_convert_em - assert_equal 'em', @to.convert('<em>em</em>') - assert_equal 'em', @to.convert('*em*') - end - - def test_convert_em_dash # for HTML conversion - assert_equal '-', @to.convert('--') - end - - def test_convert_escape - assert_equal 'a+-3E+b', @to.convert('a > b') - end - - def test_convert_tidylink - assert_equal 'text', @to.convert('{text}[stuff]') - assert_equal 'text', @to.convert('text[stuff]') - end - - def test_convert_tt - assert_equal 'tt', @to.convert('<tt>tt</tt>') - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_markdown.rb b/test/rdoc/test_rdoc_markup_to_markdown.rb deleted file mode 100644 index 86fe5ce82b..0000000000 --- a/test/rdoc/test_rdoc_markup_to_markdown.rb +++ /dev/null @@ -1,397 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class RDocMarkupToMarkdownTest < RDoc::Markup::TextFormatterTestCase - - add_visitor_tests - add_text_tests - - def setup - super - - @to = RDoc::Markup::ToMarkdown.new - end - - def accept_blank_line - assert_equal "\n", @to.res.join - end - - def accept_block_quote - assert_equal "> quote\n", @to.res.join - end - - def accept_document - assert_equal "hello\n", @to.res.join - end - - def accept_heading - assert_equal "##### Hello\n", @to.res.join - end - - def accept_list_end_bullet - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_label - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_lalpha - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_note - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_number - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_ualpha - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_item_end_bullet - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_label - assert_equal "cat\n: \n", @to.res.join - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_lalpha - assert_equal 0, @to.indent, 'indent' - assert_equal 2, @to.list_index.last - end - - def accept_list_item_end_note - assert_equal "cat\n: \n", @to.res.join - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_number - assert_equal 0, @to.indent, 'indent' - assert_equal 2, @to.list_index.last - end - - def accept_list_item_end_ualpha - assert_equal 0, @to.indent, 'indent' - assert_equal 2, @to.list_index.last - end - - def accept_list_item_start_bullet - assert_equal [""], @to.res - assert_equal '* ', @to.prefix - end - - def accept_list_item_start_label - assert_equal [""], @to.res - assert_equal "cat\n: ", @to.prefix - - assert_equal 4, @to.indent - end - - def accept_list_item_start_lalpha - assert_equal [""], @to.res - assert_equal '1. ', @to.prefix - - assert_equal 1, @to.list_index.last - assert_equal 4, @to.indent - end - - def accept_list_item_start_note - assert_equal [""], @to.res - assert_equal "cat\n: ", @to.prefix - - assert_equal 4, @to.indent - end - - def accept_list_item_start_number - assert_equal [""], @to.res - assert_equal '1. ', @to.prefix - - assert_equal 1, @to.list_index.last - assert_equal 4, @to.indent - end - - def accept_list_item_start_ualpha - assert_equal [""], @to.res - assert_equal '1. ', @to.prefix - - assert_equal 1, @to.list_index.last - assert_equal 4, @to.indent - end - - def accept_list_start_bullet - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:BULLET], @to.list_type - assert_equal [4], @to.list_width - end - - def accept_list_start_label - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:LABEL], @to.list_type - assert_equal [4], @to.list_width - end - - def accept_list_start_lalpha - assert_equal "", @to.res.join - assert_equal [1], @to.list_index - assert_equal [:LALPHA], @to.list_type - assert_equal [4], @to.list_width - end - - def accept_list_start_note - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:NOTE], @to.list_type - assert_equal [4], @to.list_width - end - - def accept_list_start_number - assert_equal "", @to.res.join - assert_equal [1], @to.list_index - assert_equal [:NUMBER], @to.list_type - assert_equal [4], @to.list_width - end - - def accept_list_start_ualpha - assert_equal "", @to.res.join - assert_equal [1], @to.list_index - assert_equal [:UALPHA], @to.list_type - assert_equal [4], @to.list_width - end - - def accept_paragraph - assert_equal "hi\n", @to.res.join - end - - def accept_raw - raw = <<-RAW.rstrip -<table> -<tr><th>Name<th>Count -<tr><td>a<td>1 -<tr><td>b<td>2 -</table> - RAW - - assert_equal raw, @to.res.join - end - - def accept_rule - assert_equal "---\n", @to.res.join - end - - def accept_verbatim - assert_equal " hi\n world\n\n", @to.res.join - end - - def end_accepting - assert_equal "hi", @to.end_accepting - end - - def start_accepting - assert_equal 0, @to.indent - assert_equal [""], @to.res - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_heading_1 - assert_equal "# Hello\n", @to.end_accepting - end - - def accept_heading_2 - assert_equal "## Hello\n", @to.end_accepting - end - - def accept_heading_3 - assert_equal "### Hello\n", @to.end_accepting - end - - def accept_heading_4 - assert_equal "#### Hello\n", @to.end_accepting - end - - def accept_heading_indent - assert_equal " # Hello\n", @to.end_accepting - end - - def accept_heading_b - assert_equal "# **Hello**\n", @to.end_accepting - end - - def accept_heading_suppressed_crossref - assert_equal "# Hello\n", @to.end_accepting - end - - def accept_list_item_start_note_2 - assert_equal "`teletype`\n: teletype description\n\n", @to.res.join - end - - def accept_list_item_start_note_multi_description - assert_equal "label\n: description one\n\n: description two\n\n", - @to.res.join - end - - def accept_list_item_start_note_multi_label - assert_equal "one\ntwo\n: two headers\n\n", @to.res.join - end - - def accept_paragraph_b - assert_equal "reg **bold words** reg\n", @to.end_accepting - end - - def accept_paragraph_br - assert_equal "one \ntwo\n", @to.end_accepting - end - - def accept_paragraph_break - assert_equal "hello \nworld\n", @to.end_accepting - end - - def accept_paragraph_i - assert_equal "reg *italic words* reg\n", @to.end_accepting - end - - def accept_paragraph_indent - expected = <<-EXPECTED - words words words words words words words words words words words words - words words words words words words words words words words words words - words words words words words words - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_paragraph_plus - assert_equal "reg `teletype` reg\n", @to.end_accepting - end - - def accept_paragraph_star - assert_equal "reg **bold** reg\n", @to.end_accepting - end - - def accept_paragraph_underscore - assert_equal "reg *italic* reg\n", @to.end_accepting - end - - def accept_paragraph_wrap - expected = <<-EXPECTED -words words words words words words words words words words words words words -words words words words words words words words words words words words words -words words words words - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_rule_indent - assert_equal " ---\n", @to.end_accepting - end - - def accept_verbatim_indent - assert_equal " hi\n world\n\n", @to.end_accepting - end - - def accept_verbatim_big_indent - assert_equal " hi\n world\n\n", @to.end_accepting - end - - def list_nested - expected = <<-EXPECTED -* l1 - * l1.1 -* l2 - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def list_verbatim - expected = <<-EXPECTED # HACK overblown -* list stuff - - * list - with - - second - - 1. indented - 2. numbered - - third - - * second - - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_table_align - expected = <<-EXPECTED - AA |BB |CCCCC|DDDDD -----|---|-----|----- - |bbb| c| -aaaa|b | | dd - a | | cc| dd - EXPECTED - assert_equal expected, @to.end_accepting - end - - def test_convert_RDOCLINK - result = @to.convert 'rdoc-garbage:C' - - assert_equal "C\n", result - end - - def test_convert_RDOCLINK_image - result = @to.convert 'rdoc-image:/path/to/image.jpg' - - assert_equal "![](/path/to/image.jpg)\n", result - end - - def test_convert_TIDYLINK - result = @to.convert \ - '{DSL}[https://en.wikipedia.org/wiki/Domain-specific_language]' - - expected = "[DSL](https://en.wikipedia.org/wiki/Domain-specific_language)\n" - - assert_equal expected, result - end - - def test_handle_rdoc_link_label_footmark - assert_equal '[^1]:', @to.handle_rdoc_link('rdoc-label:footmark-1:x') - end - - def test_handle_rdoc_link_label_foottext - assert_equal '[^1]', @to.handle_rdoc_link('rdoc-label:foottext-1:x') - end - - def test_handle_rdoc_link_label_label - assert_equal '[x](#label-x)', @to.handle_rdoc_link('rdoc-label:label-x') - end - - def test_handle_rdoc_link_ref - assert_equal 'x', @to.handle_rdoc_link('rdoc-ref:x') - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_rdoc.rb b/test/rdoc/test_rdoc_markup_to_rdoc.rb deleted file mode 100644 index c7d6120c0d..0000000000 --- a/test/rdoc/test_rdoc_markup_to_rdoc.rb +++ /dev/null @@ -1,388 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class RDocMarkupToRDocTest < RDoc::Markup::TextFormatterTestCase - - add_visitor_tests - add_text_tests - - def setup - super - - @to = RDoc::Markup::ToRdoc.new - end - - def accept_blank_line - assert_equal "\n", @to.res.join - end - - def accept_block_quote - assert_equal "> quote\n", @to.res.join - end - - def accept_document - assert_equal "hello\n", @to.res.join - end - - def accept_heading - assert_equal "===== Hello\n", @to.res.join - end - - def accept_list_end_bullet - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_label - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_lalpha - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_note - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_number - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_end_ualpha - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_list_item_end_bullet - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_label - assert_equal "[cat]\n", @to.res.join - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_lalpha - assert_equal 0, @to.indent, 'indent' - assert_equal 'b', @to.list_index.last - end - - def accept_list_item_end_note - assert_equal "cat::\n", @to.res.join - assert_equal 0, @to.indent, 'indent' - end - - def accept_list_item_end_number - assert_equal 0, @to.indent, 'indent' - assert_equal 2, @to.list_index.last - end - - def accept_list_item_end_ualpha - assert_equal 0, @to.indent, 'indent' - assert_equal 'B', @to.list_index.last - end - - def accept_list_item_start_bullet - assert_equal [""], @to.res - assert_equal '* ', @to.prefix - end - - def accept_list_item_start_label - assert_equal [""], @to.res - assert_equal "[cat]\n ", @to.prefix - - assert_equal 2, @to.indent - end - - def accept_list_item_start_lalpha - assert_equal [""], @to.res - assert_equal 'a. ', @to.prefix - - assert_equal 'a', @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_item_start_note - assert_equal [""], @to.res - assert_equal "cat::\n ", @to.prefix - - assert_equal 2, @to.indent - end - - def accept_list_item_start_number - assert_equal [""], @to.res - assert_equal '1. ', @to.prefix - - assert_equal 1, @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_item_start_ualpha - assert_equal [""], @to.res - assert_equal 'A. ', @to.prefix - - assert_equal 'A', @to.list_index.last - assert_equal 3, @to.indent - end - - def accept_list_start_bullet - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:BULLET], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_label - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:LABEL], @to.list_type - assert_equal [2], @to.list_width - end - - def accept_list_start_lalpha - assert_equal "", @to.res.join - assert_equal ['a'], @to.list_index - assert_equal [:LALPHA], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_note - assert_equal "", @to.res.join - assert_equal [nil], @to.list_index - assert_equal [:NOTE], @to.list_type - assert_equal [2], @to.list_width - end - - def accept_list_start_number - assert_equal "", @to.res.join - assert_equal [1], @to.list_index - assert_equal [:NUMBER], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_list_start_ualpha - assert_equal "", @to.res.join - assert_equal ['A'], @to.list_index - assert_equal [:UALPHA], @to.list_type - assert_equal [1], @to.list_width - end - - def accept_paragraph - assert_equal "hi\n", @to.res.join - end - - def accept_raw - raw = <<-RAW.rstrip -<table> -<tr><th>Name<th>Count -<tr><td>a<td>1 -<tr><td>b<td>2 -</table> - RAW - - assert_equal raw, @to.res.join - end - - def accept_rule - assert_equal "#{'-' * 78}\n", @to.res.join - end - - def accept_verbatim - assert_equal " hi\n world\n\n", @to.res.join - end - - def end_accepting - assert_equal "hi", @to.end_accepting - end - - def start_accepting - assert_equal 0, @to.indent - assert_equal [""], @to.res - assert_empty @to.list_index - assert_empty @to.list_type - assert_empty @to.list_width - end - - def accept_heading_1 - assert_equal "= Hello\n", @to.end_accepting - end - - def accept_heading_2 - assert_equal "== Hello\n", @to.end_accepting - end - - def accept_heading_3 - assert_equal "=== Hello\n", @to.end_accepting - end - - def accept_heading_4 - assert_equal "==== Hello\n", @to.end_accepting - end - - def accept_heading_indent - assert_equal " = Hello\n", @to.end_accepting - end - - def accept_heading_b - assert_equal "= <b>Hello</b>\n", @to.end_accepting - end - - def accept_heading_suppressed_crossref - assert_equal "= Hello\n", @to.end_accepting - end - - def accept_list_item_start_note_2 - assert_equal "<tt>teletype</tt>::\n teletype description\n\n", @to.res.join - end - - def accept_list_item_start_note_multi_description - assert_equal "label::\n description one\n\n description two\n\n", - @to.res.join - end - - def accept_list_item_start_note_multi_label - assert_equal "one::\ntwo::\n two headers\n\n", @to.res.join - end - - def accept_paragraph_b - assert_equal "reg <b>bold words</b> reg\n", @to.end_accepting - end - - def accept_paragraph_br - assert_equal "one\ntwo\n", @to.end_accepting - end - - def accept_paragraph_break - assert_equal "hello\nworld\n", @to.end_accepting - end - - def accept_paragraph_i - assert_equal "reg <em>italic words</em> reg\n", @to.end_accepting - end - - def accept_paragraph_indent - expected = <<-EXPECTED - words words words words words words words words words words words words - words words words words words words words words words words words words - words words words words words words - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_paragraph_plus - assert_equal "reg <tt>teletype</tt> reg\n", @to.end_accepting - end - - def accept_paragraph_star - assert_equal "reg <b>bold</b> reg\n", @to.end_accepting - end - - def accept_paragraph_underscore - assert_equal "reg <em>italic</em> reg\n", @to.end_accepting - end - - def accept_paragraph_wrap - expected = <<-EXPECTED -words words words words words words words words words words words words words -words words words words words words words words words words words words words -words words words words - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_rule_indent - assert_equal " #{'-' * 75}\n", @to.end_accepting - end - - def accept_verbatim_indent - assert_equal " hi\n world\n\n", @to.end_accepting - end - - def accept_verbatim_big_indent - assert_equal " hi\n world\n\n", @to.end_accepting - end - - def list_nested - expected = <<-EXPECTED -* l1 - * l1.1 -* l2 - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def list_verbatim - expected = <<-EXPECTED # HACK overblown -* list stuff - - * list - with - - second - - 1. indented - 2. numbered - - third - - * second - - EXPECTED - - assert_equal expected, @to.end_accepting - end - - def accept_table_align - expected = <<-EXPECTED - AA |BB |CCCCC|DDDDD -----|---|-----|----- - |bbb| c| -aaaa|b | | dd - a | | cc| dd - EXPECTED - assert_equal expected, @to.end_accepting - end - - # functional test - def test_convert_list_note - note_list = <<-NOTE_LIST -foo :: -bar :: - hi - NOTE_LIST - - expected = <<-EXPECTED -foo:: -bar:: - hi - - EXPECTED - - assert_equal expected, @to.convert(note_list) - end - - def test_accept_indented_paragraph - ip = RDoc::Markup::IndentedParagraph.new 2, 'cats are cool' - - @to.start_accepting - - @to.accept_indented_paragraph ip - - assert_equal " cats are cool\n", @to.end_accepting - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_table_of_contents.rb b/test/rdoc/test_rdoc_markup_to_table_of_contents.rb deleted file mode 100644 index 7512495aec..0000000000 --- a/test/rdoc/test_rdoc_markup_to_table_of_contents.rb +++ /dev/null @@ -1,126 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupToTableOfContents < RDoc::Markup::FormatterTestCase - - add_visitor_tests - - def setup - super - - @to = RDoc::Markup::ToTableOfContents.new - end - - def end_accepting - assert_equal %w[hi], @to.res - end - - def empty - assert_empty @to.res - end - - def accept_heading - assert_equal [@RM::Heading.new(5, 'Hello')], @to.res - end - - def accept_heading_1 - assert_equal [@RM::Heading.new(1, 'Hello')], @to.res - end - - def accept_heading_2 - assert_equal [@RM::Heading.new(2, 'Hello')], @to.res - end - - def accept_heading_3 - assert_equal [@RM::Heading.new(3, 'Hello')], @to.res - end - - def accept_heading_4 - assert_equal [@RM::Heading.new(4, 'Hello')], @to.res - end - - def accept_heading_b - assert_equal [@RM::Heading.new(1, '*Hello*')], @to.res - end - - def accept_heading_suppressed_crossref - assert_equal [@RM::Heading.new(1, '\\Hello')], @to.res - end - - alias accept_blank_line empty - alias accept_block_quote empty - alias accept_document empty - alias accept_list_end_bullet empty - alias accept_list_end_label empty - alias accept_list_end_lalpha empty - alias accept_list_end_note empty - alias accept_list_end_number empty - alias accept_list_end_ualpha empty - alias accept_list_item_end_bullet empty - alias accept_list_item_end_label empty - alias accept_list_item_end_lalpha empty - alias accept_list_item_end_note empty - alias accept_list_item_end_number empty - alias accept_list_item_end_ualpha empty - alias accept_list_item_start_bullet empty - alias accept_list_item_start_label empty - alias accept_list_item_start_lalpha empty - alias accept_list_item_start_note empty - alias accept_list_item_start_note_2 empty - alias accept_list_item_start_note_multi_description empty - alias accept_list_item_start_note_multi_label empty - alias accept_list_item_start_number empty - alias accept_list_item_start_ualpha empty - alias accept_list_start_bullet empty - alias accept_list_start_label empty - alias accept_list_start_lalpha empty - alias accept_list_start_note empty - alias accept_list_start_number empty - alias accept_list_start_ualpha empty - alias accept_paragraph empty - alias accept_paragraph_b empty - alias accept_paragraph_br empty - alias accept_paragraph_break empty - alias accept_paragraph_i empty - alias accept_paragraph_plus empty - alias accept_paragraph_star empty - alias accept_paragraph_underscore empty - alias accept_raw empty - alias accept_rule empty - alias accept_verbatim empty - alias list_nested empty - alias list_verbatim empty - alias start_accepting empty - - def test_accept_document_omit_headings_below - document = doc - document.omit_headings_below = 2 - - @to.accept_document document - - assert_equal 2, @to.omit_headings_below - end - - def test_accept_heading_suppressed - @to.start_accepting - @to.omit_headings_below = 4 - - suppressed = head 5, 'Hello' - - @to.accept_heading suppressed - - assert_empty @to.res - end - - def test_suppressed_eh - @to.omit_headings_below = nil - - refute @to.suppressed? head(1, '') - - @to.omit_headings_below = 1 - - refute @to.suppressed? head(1, '') - assert @to.suppressed? head(2, '') - end - -end diff --git a/test/rdoc/test_rdoc_markup_to_tt_only.rb b/test/rdoc/test_rdoc_markup_to_tt_only.rb deleted file mode 100644 index c709d7a4d5..0000000000 --- a/test/rdoc/test_rdoc_markup_to_tt_only.rb +++ /dev/null @@ -1,246 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupToTtOnly < RDoc::Markup::FormatterTestCase - - add_visitor_tests - - def setup - super - - @to = RDoc::Markup::ToTtOnly.new - end - - def accept_blank_line - assert_empty @to.end_accepting - end - - def accept_block_quote - assert_empty @to.end_accepting - end - - def accept_document - assert_equal [], @to.res - end - - def accept_heading - assert_empty @to.end_accepting - end - - def accept_list_end_bullet - assert_empty @to.res - end - - def accept_list_end_label - assert_empty @to.res - end - - def accept_list_end_lalpha - assert_empty @to.res - end - - def accept_list_end_note - assert_empty @to.res - end - - def accept_list_end_number - assert_empty @to.res - end - - def accept_list_end_ualpha - assert_empty @to.res - end - - def accept_list_item_end_bullet - assert_empty @to.res - end - - def accept_list_item_end_label - assert_empty @to.res - end - - def accept_list_item_end_lalpha - assert_empty @to.res - end - - def accept_list_item_end_note - assert_empty @to.res - end - - def accept_list_item_end_number - assert_empty @to.res - end - - def accept_list_item_end_ualpha - assert_empty @to.res - end - - def accept_list_item_start_bullet - assert_empty @to.res - end - - def accept_list_item_start_label - assert_empty @to.res - end - - def accept_list_item_start_lalpha - assert_empty @to.res - end - - def accept_list_item_start_note - assert_empty @to.res - end - - def accept_list_item_start_number - assert_empty @to.res - end - - def accept_list_item_start_ualpha - assert_empty @to.res - end - - def accept_list_start_bullet - assert_empty @to.res - end - - def accept_list_start_label - assert_empty @to.res - end - - def accept_list_start_lalpha - assert_empty @to.res - end - - def accept_list_start_note - assert_empty @to.res - end - - def accept_list_start_number - assert_empty @to.res - end - - def accept_list_start_ualpha - assert_empty @to.res - end - - def accept_paragraph - assert_empty @to.end_accepting - end - - def accept_paragraph_break - assert_empty @to.end_accepting - end - - def accept_raw - assert_empty @to.end_accepting - end - - def accept_rule - assert_empty @to.end_accepting - end - - def accept_verbatim - assert_empty @to.end_accepting - end - - def end_accepting - assert_equal %w[hi], @to.end_accepting - end - - def start_accepting - assert_empty @to.end_accepting - end - - def accept_heading_1 - assert_empty @to.end_accepting - end - - def accept_heading_2 - assert_empty @to.end_accepting - end - - def accept_heading_3 - assert_empty @to.end_accepting - end - - def accept_heading_4 - assert_empty @to.end_accepting - end - - def accept_heading_indent - assert_empty @to.end_accepting - end - - def accept_heading_b - assert_empty @to.end_accepting - end - - def accept_heading_suppressed_crossref - assert_empty @to.end_accepting - end - - def accept_list_item_start_note_2 - assert_equal [nil, 'teletype', nil], @to.res - end - - def accept_list_item_start_note_multi_description - assert_empty @to.res - end - - def accept_list_item_start_note_multi_label - assert_empty @to.res - end - - def accept_paragraph_b - assert_empty @to.end_accepting - end - - def accept_paragraph_br - assert_empty @to.end_accepting - end - - def accept_paragraph_i - assert_empty @to.end_accepting - end - - def accept_paragraph_indent - assert_empty @to.end_accepting - end - - def accept_paragraph_plus - assert_equal %w[teletype], @to.end_accepting - end - - def accept_paragraph_star - assert_empty @to.end_accepting - end - - def accept_paragraph_underscore - assert_empty @to.end_accepting - end - - def accept_paragraph_wrap - assert_empty @to.end_accepting - end - - def accept_rule_indent - assert_empty @to.end_accepting - end - - def accept_verbatim_indent - assert_empty @to.end_accepting - end - - def accept_verbatim_big_indent - assert_empty @to.end_accepting - end - - def list_nested - assert_empty @to.end_accepting - end - - def list_verbatim - assert_empty @to.end_accepting - end - -end diff --git a/test/rdoc/test_rdoc_markup_verbatim.rb b/test/rdoc/test_rdoc_markup_verbatim.rb deleted file mode 100644 index 2f8a57266a..0000000000 --- a/test/rdoc/test_rdoc_markup_verbatim.rb +++ /dev/null @@ -1,29 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupVerbatim < RDoc::TestCase - - def test_equals2 - v1 = verb('1 + 1') - v2 = verb('1 + 1') - v3 = verb('1 + 2') - v4 = verb('1 + 1') - v4.format = :ruby - - assert_equal v1, v2 - - refute_equal v1, v3 - refute_equal v1, v4 - end - - def test_ruby_eh - verbatim = RDoc::Markup::Verbatim.new - - refute verbatim.ruby? - - verbatim.format = :ruby - - assert verbatim.ruby? - end - -end diff --git a/test/rdoc/test_rdoc_method_attr.rb b/test/rdoc/test_rdoc_method_attr.rb deleted file mode 100644 index 29ccc3372c..0000000000 --- a/test/rdoc/test_rdoc_method_attr.rb +++ /dev/null @@ -1,219 +0,0 @@ -# frozen_string_literal: true -require_relative 'xref_test_case' - -class TestRDocMethodAttr < XrefTestCase - - def test_initialize_copy - refute_same @c1_m.full_name, @c1_m.dup.full_name - end - - def test_block_params_equal - m = RDoc::MethodAttr.new(nil, 'foo') - - m.block_params = '' - assert_equal '', m.block_params - - m.block_params = 'a_var' - assert_equal 'a_var', m.block_params - - m.block_params = '()' - assert_equal '', m.block_params - - m.block_params = '(a_var, b_var)' - assert_equal 'a_var, b_var', m.block_params - - m.block_params = '.to_s + "</#{element.upcase}>"' - assert_equal '', m.block_params - - m.block_params = 'i.name' - assert_equal 'name', m.block_params - - m.block_params = 'attr.expanded_name, attr.value' - assert_equal 'expanded_name, value', m.block_params - - m.block_params = 'expanded_name, attr.value' - assert_equal 'expanded_name, value', m.block_params - - m.block_params = 'attr.expanded_name, value' - assert_equal 'expanded_name, value', m.block_params - - m.block_params = '(@base_notifier)' - assert_equal 'base_notifier', m.block_params - - m.block_params = 'if @signal_status == :IN_LOAD' - assert_equal '', m.block_params - - m.block_params = 'e if e.kind_of? Element' - assert_equal 'e', m.block_params - - m.block_params = '(e, f) if e.kind_of? Element' - assert_equal 'e, f', m.block_params - - m.block_params = 'back_path, back_name' - assert_equal 'back_path, back_name', m.block_params - - m.block_params = '(*a[1..-1])' - assert_equal '*a', m.block_params - - m.block_params = '@@context[:node] if defined? @@context[:node].namespace' - assert_equal 'context', m.block_params - - m.block_params = '(result, klass.const_get(constant_name))' - assert_equal 'result, const', m.block_params - - m.block_params = 'name.to_s if (bitmap & bit) != 0' - assert_equal 'name', m.block_params - - m.block_params = 'line unless line.deleted' - assert_equal 'line', m.block_params - - m.block_params = 'str + rs' - assert_equal 'str', m.block_params - - m.block_params = 'f+rs' - assert_equal 'f', m.block_params - - m.block_params = '[user, realm, hash[user]]' - assert_equal 'user, realm, hash', m.block_params - - m.block_params = 'proc{|rc| rc == "rc" ? irbrc : irbrc+rc| ... }' - assert_equal 'proc', m.block_params - - m.block_params = 'lambda { |x| x.to_i }' - assert_equal 'lambda', m.block_params - - m.block_params = '$&' - assert_equal 'str', m.block_params - - m.block_params = 'Inflections.instance' - assert_equal 'instance', m.block_params - - m.block_params = 'self.class::STARTED' - assert_equal 'STARTED', m.block_params - - m.block_params = 'Test::Unit::TestCase::STARTED' - assert_equal 'STARTED', m.block_params - - m.block_params = 'ActiveSupport::OptionMerger.new(self, options)' - assert_equal 'option_merger', m.block_params - - m.block_params = ', msg' - assert_equal '', m.block_params - - m.block_params = '[size.to_s(16), term, chunk, term].join' - assert_equal '[size, term, chunk, term].join', m.block_params - - m.block_params = 'YPath.new( path )' - assert_equal 'y_path', m.block_params - - end - - def test_find_method_or_attribute_recursive - inc = RDoc::Include.new 'M1', nil - @m1.add_include inc # M1 now includes itself - - assert_nil @m1_m.find_method_or_attribute 'm' - end - - def test_full_name - assert_equal 'C1#m', @c1_m.full_name - assert_equal 'C1::m', @c1__m.full_name - end - - def test_is_alias_for - assert_equal @c2_b, @c2_a.is_alias_for - end - - def test_output_name - assert_equal '#m', @c1_m.output_name(@c1) - assert_equal '::m', @c1__m.output_name(@c1) - - assert_equal 'C1#m', @c1_m.output_name(@c2) - assert_equal 'C1.m', @c1__m.output_name(@c2) - end - - def test_search_record - @c1_m.comment = 'This is a comment.' - - expected = [ - 'm', - 'C1#m', - 'm', - 'C1', - 'C1.html#method-i-m', - '(foo)', - "<p>This is a comment.\n", - ] - - assert_equal expected, @c1_m.search_record - end - - def test_spaceship_returns_nil_on_inappropriate_types - assert_nil @c1_m.<=>(RDoc::CodeObject.new) - end - - def test_spaceship_orders_symbols_first - # in the desired sort order - m_plus = RDoc::AnyMethod.new nil, '+' - m_eqeq = RDoc::AnyMethod.new nil, '==' - m_bracket = RDoc::AnyMethod.new nil, '[]' - m_caret = RDoc::AnyMethod.new nil, '^' - m_bar = RDoc::AnyMethod.new nil, '|' - m_tilde = RDoc::AnyMethod.new nil, '~' - m_Alpha = RDoc::AnyMethod.new nil, 'Alpha' - m_Zero = RDoc::AnyMethod.new nil, 'Zero' - m_alpha = RDoc::AnyMethod.new nil, 'alpha' - m_zero = RDoc::AnyMethod.new nil, 'zero' - m_konnichiwa = RDoc::AnyMethod.new nil, 'こんにちは' - - assert_equal(-1, m_plus <=> m_eqeq) - assert_equal(-1, m_eqeq <=> m_bracket) - assert_equal(-1, m_bracket <=> m_caret) - assert_equal(-1, m_caret <=> m_bar) - assert_equal(-1, m_bar <=> m_tilde) - assert_equal(-1, m_tilde <=> m_Alpha) - assert_equal(-1, m_Alpha <=> m_Zero) - assert_equal(-1, m_Zero <=> m_alpha) - assert_equal(-1, m_alpha <=> m_zero) - assert_equal(-1, m_zero <=> m_konnichiwa) - end - - def test_equals2 - assert_equal @c1_m, @c1_m - refute_equal @c1_m, @parent_m - end - - def test_pretty_print - temp_dir do |tmpdir| - s = RDoc::RI::Store.new tmpdir - s.rdoc = @rdoc - - top_level = s.add_file 'file.rb' - meth_bang = RDoc::AnyMethod.new nil, 'method!' - meth_bang.record_location top_level - - meth_bang_alias = RDoc::Alias.new nil, 'method!', 'method_bang', '' - meth_bang_alias.record_location top_level - - klass = top_level.add_class RDoc::NormalClass, 'Object' - klass.add_method meth_bang - - meth_bang.add_alias meth_bang_alias, klass - - s.save - - meth_alias_from_store = s.load_method 'Object', '#method_bang' - - expected = "[RDoc::AnyMethod Object#method_bang public alias for method!]" - actual = mu_pp meth_alias_from_store - assert_equal expected, actual - end - end - - def test_to_s - assert_equal 'RDoc::AnyMethod: C1#m', @c1_m.to_s - assert_equal 'RDoc::AnyMethod: C2#b', @c2_b.to_s - assert_equal 'RDoc::AnyMethod: C1::m', @c1__m.to_s - end - -end diff --git a/test/rdoc/test_rdoc_normal_class.rb b/test/rdoc/test_rdoc_normal_class.rb deleted file mode 100644 index 3d097ebb52..0000000000 --- a/test/rdoc/test_rdoc_normal_class.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true -require_relative 'xref_test_case' - -class TestRDocNormalClass < XrefTestCase - - def test_ancestors - klass = @top_level.add_class RDoc::NormalClass, 'Klass' - incl = RDoc::Include.new 'Incl', '' - - sub_klass = @top_level.add_class RDoc::NormalClass, 'SubClass' - sub_klass.superclass = klass - sub_klass.add_include incl - - assert_equal [incl.name, klass, @object, 'BasicObject'], sub_klass.ancestors - end - - def test_ancestors_multilevel - c1 = @top_level.add_class RDoc::NormalClass, 'Outer' - c2 = @top_level.add_class RDoc::NormalClass, 'Middle', c1.full_name - c3 = @top_level.add_class RDoc::NormalClass, 'Inner', c2.full_name - - assert_equal [c2, c1, @object, 'BasicObject'], c3.ancestors - end - - def test_aref - assert_equal 'class-C1', @c1.aref - assert_equal 'class-C2::C3', @c2_c3.aref - end - - def test_direct_ancestors - incl = RDoc::Include.new 'Incl', '' - - c1 = @top_level.add_class RDoc::NormalClass, 'Outer' - c2 = @top_level.add_class RDoc::NormalClass, 'Middle', c1.full_name - c3 = @top_level.add_class RDoc::NormalClass, 'Inner', c2.full_name - c3.add_include incl - - assert_equal [incl.name, c2], c3.direct_ancestors - end - - def test_definition - c = RDoc::NormalClass.new 'C' - - assert_equal 'class C', c.definition - end - -end diff --git a/test/rdoc/test_rdoc_normal_module.rb b/test/rdoc/test_rdoc_normal_module.rb deleted file mode 100644 index cccee5c44c..0000000000 --- a/test/rdoc/test_rdoc_normal_module.rb +++ /dev/null @@ -1,42 +0,0 @@ -# frozen_string_literal: true -require_relative 'xref_test_case' - -class TestRDocNormalModule < XrefTestCase - - def setup - super - - @mod = RDoc::NormalModule.new 'Mod' - end - - def test_ancestors_module - top_level = @store.add_file 'file.rb' - mod = top_level.add_module RDoc::NormalModule, 'Mod' - incl = RDoc::Include.new 'Incl', '' - - mod.add_include incl - - assert_equal [incl.name], mod.ancestors - - mod2 = top_level.add_module RDoc::NormalModule, 'Inc2' - inc2 = RDoc::Include.new 'Inc2', '' - mod.add_include inc2 - assert_equal [mod2, incl.name], mod.ancestors - end - - def test_aref - assert_equal 'module-M1', @m1.aref - assert_equal 'module-M1::M2', @m1_m2.aref - end - - def test_definition - m = RDoc::NormalModule.new 'M' - - assert_equal 'module M', m.definition - end - - def test_module_eh - assert @mod.module? - end - -end diff --git a/test/rdoc/test_rdoc_options.rb b/test/rdoc/test_rdoc_options.rb deleted file mode 100644 index 9fc6830239..0000000000 --- a/test/rdoc/test_rdoc_options.rb +++ /dev/null @@ -1,972 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocOptions < RDoc::TestCase - - def setup - super - - @options = RDoc::Options.new - @generators = RDoc::RDoc::GENERATORS.dup - end - - def teardown - super - - RDoc::RDoc::GENERATORS.replace @generators - end - - def test_check_files - omit "assumes UNIX permission model" if /mswin|mingw/ =~ RUBY_PLATFORM - omit "assumes that euid is not root" if Process.euid == 0 - - out, err = capture_output do - temp_dir do - FileUtils.touch 'unreadable' - FileUtils.chmod 0, 'unreadable' - - @options.files = %w[nonexistent unreadable] - - @options.check_files - end - end - - assert_empty @options.files - - assert_empty out - assert_empty err - end - - def test_check_files_warn - @options.verbosity = 2 - - out, err = verbose_capture_output do - @options.files = %w[nonexistent] - - @options.check_files - end - - assert_empty out - assert_equal "file 'nonexistent' not found\n", err - assert_empty @options.files - end - - def test_dry_run_default - refute @options.dry_run - end - - def test_to_yaml - RDoc.load_yaml - - coder = YAML.load(@options.to_yaml) - - encoding = 'UTF-8' - - expected = { - 'charset' => 'UTF-8', - 'encoding' => encoding, - 'embed_mixins' => false, - 'exclude' => [], - 'hyperlink_all' => false, - 'line_numbers' => false, - 'locale_dir' => 'locale', - 'locale_name' => nil, - 'main_page' => nil, - 'markup' => 'rdoc', - 'output_decoration' => true, - 'page_dir' => nil, - 'rdoc_include' => [], - 'show_hash' => false, - 'static_path' => [], - 'tab_width' => 8, - 'template_stylesheets' => [], - 'title' => nil, - 'visibility' => :protected, - 'warn_missing_rdoc_ref' => false, - 'webcvs' => nil, - 'skip_tests' => true, - 'apply_default_exclude' => true, - 'autolink_excluded_words' => [], - } - - assert_equal expected, coder - end - - def test_to_yaml_trim_paths - RDoc.load_yaml - - subdir = nil - coder = nil - - temp_dir do |dir| - FileUtils.mkdir 'project' - FileUtils.mkdir 'dir' - FileUtils.touch 'file' - - Dir.chdir 'project' do - subdir = File.expand_path 'subdir' - FileUtils.mkdir 'subdir' - @options.parse %w[ - --copy subdir - --copy ../file - --copy ../ - --copy / - --include subdir - --include ../dir - --include ../ - --include / - ] - - coder = YAML.load(@options.to_yaml) - end - end - - assert_equal [subdir], coder['rdoc_include'] - - assert_equal [subdir], coder['static_path'] - end - - def test_encoding_default - assert_equal Encoding::UTF_8, @options.encoding - end - - def test_generator_descriptions - # HACK autotest/isolate should take care of this - RDoc::RDoc::GENERATORS.clear - RDoc::RDoc::GENERATORS['darkfish'] = RDoc::Generator::Darkfish - RDoc::RDoc::GENERATORS['ri'] = RDoc::Generator::RI - - expected = <<-EXPECTED.chomp - darkfish - HTML generator, written by Michael Granger - ri - creates ri data files - EXPECTED - - assert_equal expected, @options.generator_descriptions - end - - def test_init_with_encoding - RDoc.load_yaml - - @options.encoding = Encoding::IBM437 - - options = @options.to_yaml - options = YAML.safe_load(options, permitted_classes: [Symbol]) - options = RDoc::Options.new(options) - - assert_equal Encoding::IBM437, options.encoding - end - - def test_init_with_trim_paths - RDoc.load_yaml - - yaml = <<-YAML ---- -static_path: -- /etc -rdoc_include: -- /etc - YAML - - options = YAML.safe_load(yaml, permitted_classes: [Symbol]) - options = RDoc::Options.new(options) - - assert_empty options.rdoc_include - assert_empty options.static_path - end - - def test_parse_copy_files_file_relative - file = File.basename __FILE__ - expected = File.expand_path __FILE__ - - Dir.chdir File.expand_path('..', __FILE__) do - @options.parse %W[--copy-files #{file}] - - assert_equal [expected], @options.static_path - end - end - - def test_parse_copy_files_file_absolute - @options.parse %W[--copy-files #{File.expand_path __FILE__}] - - assert_equal [File.expand_path(__FILE__)], @options.static_path - end - - def test_parse_copy_files_directory_relative - @options.parse %w[--copy-files .] - - assert_equal [@pwd], @options.static_path - end - - def test_parse_copy_files_directory_absolute - @options.parse %w[--copy-files /] - - assert_equal 1, @options.static_path.length - - assert_match %r%^([A-Z]:)?/$%i, @options.static_path.first - end - - def test_parse_coverage - @options.parse %w[--dcov] - - assert @options.coverage_report - assert @options.force_update - end - - def test_parse_coverage_C - @options.parse %w[-C] - - assert @options.coverage_report - assert @options.force_update - end - - def test_parse_coverage_no - @options.parse %w[--no-dcov] - - refute @options.coverage_report - end - - def test_parse_coverage_level_1 - @options.parse %w[--dcov=1] - - assert_equal 1, @options.coverage_report - end - - def test_parse_coverage_C_level_1 - @options.parse %w[-C1] - - assert_equal 1, @options.coverage_report - end - - def test_parse_coverage_C_level_0 - @options.parse %w[-C0] - - assert_equal 0, @options.coverage_report - assert @options.force_update - end - - def test_parse_dash_p - out, err = capture_output do - @options.parse %w[-p] - end - - assert @options.pipe - refute_match %r%^Usage: %, err - refute_match %r%^invalid options%, err - - assert_empty out - end - - def test_parse_dash_p_files - out, err = capture_output do - @options.parse ['-p', File.expand_path(__FILE__)] - end - - refute @options.pipe - refute_match %r%^Usage: %, err - assert_match %r%^invalid options: -p .with files.%, err - - assert_empty out - end - - def test_parse_default - @options.parse [] - @options.finish - - assert_equal RDoc::Generator::Darkfish, @options.generator - assert_equal 'darkfish', @options.template - assert_match %r%rdoc/generator/template/darkfish$%, @options.template_dir - end - - def test_parse_deprecated - dep_hash = RDoc::Options::DEPRECATED - options = dep_hash.keys.sort - - out, err = capture_output do - @options.parse options - end - - dep_hash.each_pair do |opt, message| - assert_match %r%.*#{opt}.+#{message}%, err - end - - assert_empty out - end - - def test_parse_dry_run - @options.parse %w[--dry-run] - - assert @options.dry_run - end - - def test_parse_encoding - @options.parse %w[--encoding Big5] - - assert_equal Encoding::Big5, @options.encoding - assert_equal 'Big5', @options.charset - end - - def test_parse_encoding_invalid - out, err = capture_output do - @options.parse %w[--encoding invalid] - end - - assert_match %r%^invalid options: --encoding invalid%, err - - assert_empty out - end - - def test_parse_formatter - e = assert_raise OptionParser::InvalidOption do - @options.parse %w[--format darkfish --format ri] - end - - assert_equal 'invalid option: --format generator already set to darkfish', - e.message - end - - def test_parse_force_update - @options.parse %w[--force-update] - - assert @options.force_update - - @options.parse %w[--no-force-update] - - assert !@options.force_update - - @options.parse %w[-U] - - assert @options.force_update - end - - def test_parse_formatter_ri - e = assert_raise OptionParser::InvalidOption do - @options.parse %w[--format darkfish --ri] - end - - assert_equal 'invalid option: --ri generator already set to darkfish', - e.message - - @options = RDoc::Options.new - - e = assert_raise OptionParser::InvalidOption do - @options.parse %w[--format darkfish -r] - end - - assert_equal 'invalid option: -r generator already set to darkfish', - e.message - end - - def test_parse_formatter_ri_site - e = assert_raise OptionParser::InvalidOption do - @options.parse %w[--format darkfish --ri-site] - end - - assert_equal 'invalid option: --ri-site generator already set to darkfish', - e.message - - @options = RDoc::Options.new - - e = assert_raise OptionParser::InvalidOption do - @options.parse %w[--format darkfish -R] - end - - assert_equal 'invalid option: -R generator already set to darkfish', - e.message - end - - def test_parse_h - out, = capture_output do - begin - @options.parse %w[-h] - rescue SystemExit - end - end - - assert_equal 1, out.scan(/HTML generator options:/).length - assert_equal 1, out.scan(/ri generator options:/). length - end - - def test_parse_help - out, = capture_output do - begin - @options.parse %w[--help] - rescue SystemExit - end - end - - assert_equal 1, out.scan(/HTML generator options:/).length - assert_equal 1, out.scan(/ri generator options:/). length - end - - def test_parse_help_extra_generator - RDoc::RDoc::GENERATORS['test'] = Class.new do - def self.setup_options options - op = options.option_parser - - op.separator 'test generator options:' - end - end - - out, = capture_output do - begin - @options.parse %w[--help] - rescue SystemExit - end - end - - assert_equal 1, out.scan(/HTML generator options:/).length - assert_equal 1, out.scan(/ri generator options:/). length - assert_equal 1, out.scan(/test generator options:/).length - end - - def test_parse_format_for_extra_generator - RDoc::RDoc::GENERATORS['test'] = Class.new do - def self.setup_options options - op = options.option_parser - - op.separator 'test generator options:' - end - end - - @options.setup_generator 'test' - - assert_equal @options.generator_name, 'test' - end - - def test_parse_ignore_invalid - out, err = capture_output do - @options.parse %w[--ignore-invalid --bogus] - end - - refute_match %r%^Usage: %, err - assert_match %r%^invalid options: --bogus%, err - - assert_empty out - end - - def test_parse_ignore_invalid_default - out, err = capture_output do - @options.parse %w[--bogus --main BLAH] - end - - refute_match %r%^Usage: %, err - assert_match %r%^invalid options: --bogus%, err - - assert_equal 'BLAH', @options.main_page - - assert_empty out - end - - def test_parse_ignore_invalid_no - out, err = capture_output do - assert_raise SystemExit do - @options.parse %w[--no-ignore-invalid --bogus=arg --bobogus --visibility=extended] - end - end - - assert_match %r%^Usage: %, err - assert_match %r%^invalid options: --bogus=arg, --bobogus, --visibility=extended%, err - - assert_empty out - end - - def test_parse_ignore_invalid_no_quiet - out, err = capture_output do - assert_raise SystemExit do - @options.parse %w[--quiet --no-ignore-invalid --bogus=arg --bobogus --visibility=extended] - end - end - - refute_match %r%^Usage: %, err - assert_match %r%^invalid options: --bogus=arg, --bobogus, --visibility=extended%, err - - assert_empty out - end - - def test_ignore_needless_arg - out, err = capture_output do - @options.parse %w[--ri=foo] - end - - assert_match %r%^invalid options: --ri=foo%, err - - assert_empty out - end - - def test_ignore_missing_arg - out, err = capture_output do - @options.parse %w[--copy-files] - end - - assert_match %r%^invalid options: --copy-files%, err - - assert_empty out - end - - def test_parse_main - out, err = capture_output do - @options.parse %w[--main MAIN] - end - - assert_empty out - assert_empty err - - assert_equal 'MAIN', @options.main_page - end - - def test_parse_markup - out, err = capture_output do - @options.parse %w[--markup tomdoc] - end - - assert_empty out - assert_empty err - - assert_equal 'tomdoc', @options.markup - end - - def test_parse_page_dir - assert_nil @options.page_dir - - out, err = capture_output do - @options.parse %W[--page-dir #{Dir.tmpdir}] - @options.finish - end - - assert_empty out - assert_empty err - - expected = nil - begin - expected = - Pathname(Dir.tmpdir).expand_path.relative_path_from @options.root - rescue ArgumentError - # On Windows, sometimes crosses different drive letters. - expected = Pathname(Dir.tmpdir).expand_path - end - - assert_equal expected, @options.page_dir - assert_equal [Dir.tmpdir], @options.files - end - - def test_parse_page_dir_root - assert_nil @options.page_dir - - Dir.mktmpdir do |dir| - abs_root = dir - abs_page_dir = File.join dir, 'pages' - FileUtils.mkdir abs_page_dir - - out, err = capture_output do - @options.parse %W[--page-dir #{abs_page_dir} --root #{abs_root}] - @options.finish - end - - assert_empty out - assert_empty err - - assert_equal Pathname('pages'), @options.page_dir - assert_equal [abs_page_dir], @options.files - end - end - - def test_parse_ri_site - @options.parse %w[--ri-site] - - assert_equal RDoc::Generator::RI, @options.generator - assert_equal RDoc::RI::Paths.site_dir, @options.op_dir - end - - def test_parse_root - assert_equal Pathname(Dir.pwd), @options.root - - out, err = capture_output do - @options.parse %W[--root #{Dir.tmpdir}] - end - - assert_empty out - assert_empty err - - assert_equal Pathname(Dir.tmpdir), @options.root - - @options.finish - assert_includes @options.rdoc_include, @options.root.to_s - end - - def test_parse_embed_mixins - assert_false(@options.embed_mixins) - - out, err = capture_output { @options.parse(["--embed-mixins"]) } - assert_empty(out) - assert_empty(err) - assert_true(@options.embed_mixins) - - out, err = capture_output { @options.parse(["--no-embed-mixins"]) } - assert_empty(out) - assert_empty(err) - assert_false(@options.embed_mixins) - end - - def test_parse_tab_width - @options.parse %w[--tab-width=1] - assert_equal 1, @options.tab_width - - @options.parse %w[-w2] - assert_equal 2, @options.tab_width - - _, err = capture_output do - @options.parse %w[-w=2] - end - - assert_match 'invalid options', err - - _, err = capture_output do - @options.parse %w[-w0] - end - - assert_match 'invalid options', err - end - - def test_parse_template - out, err = capture_output do - @options.parse %w[--template darkfish] - end - - assert_empty out - assert_empty err - - assert_equal 'darkfish', @options.template - - assert_match %r%rdoc/generator/template/darkfish$%, @options.template_dir - end - - def test_parse_template_nonexistent - out, err = capture_output do - @options.parse %w[--template NONEXISTENT] - end - - assert_empty out - assert_equal "could not find template NONEXISTENT\n", err - - @options.finish - assert_equal 'darkfish', @options.template - assert_match %r%rdoc/generator/template/darkfish$%, @options.template_dir - end - - def test_parse_template_load_path - orig_LOAD_PATH = $LOAD_PATH.dup - - template_dir = nil - - Dir.mktmpdir do |dir| - $LOAD_PATH << dir - - template_dir = File.join dir, 'rdoc', 'generator', 'template', 'load_path' - - FileUtils.mkdir_p template_dir - - out, err = capture_output do - @options.parse %w[--template load_path] - end - - assert_empty out - assert_empty err - end - - assert_equal 'load_path', @options.template - assert_equal template_dir, @options.template_dir - ensure - $LOAD_PATH.replace orig_LOAD_PATH - end - - def test_parse_template_stylesheets - css = nil - Dir.mktmpdir do |dir| - css = File.join(dir, "hoge.css") - File.write(css, "") - out, err = capture_output do - @options.parse %W[--template-stylesheets #{css}] - end - - assert_empty out - assert_empty err - end - assert_include @options.template_stylesheets, css - end - - def test_parse_visibility - @options.parse %w[--visibility=public] - assert_equal :public, @options.visibility - - @options.parse %w[--visibility=protected] - assert_equal :protected, @options.visibility - - @options.parse %w[--visibility=private] - assert_equal :private, @options.visibility - - @options.parse %w[--visibility=nodoc] - assert_equal :nodoc, @options.visibility - end - - def test_parse_write_options - tmpdir = File.join Dir.tmpdir, "test_rdoc_options_#{$$}" - FileUtils.mkdir_p tmpdir - - Dir.chdir tmpdir do - e = assert_raise SystemExit do - @options.parse %w[--write-options] - @options.finish - end - - assert_equal 0, e.status - - assert File.exist? '.rdoc_options' - end - ensure - FileUtils.rm_rf tmpdir - end - - def test_parse_extension_alias - out, err = capture_output do - @options.parse %w[--extension foobar=rdoc] - end - - assert_includes RDoc::Parser.parsers, [/\.foobar$/, RDoc::Parser::Simple] - - assert_empty out - assert_empty err - end - - def test_parse_locale_name_default - temp_dir do - @options.parse %w[] - assert_equal 'locale', @options.instance_variable_get(:@locale_dir) - assert_nil @options.instance_variable_get(:@locale_name) - assert_nil @options.locale - @options.finish - assert_nil @options.locale - end - end - - def test_parse_locale_name - temp_dir do - @options.parse %w[--locale fr] - assert_equal 'locale', @options.instance_variable_get(:@locale_dir) - assert_equal 'fr', @options.instance_variable_get(:@locale_name) - assert_nil @options.locale - @options.finish - assert_equal 'fr', @options.locale.name - end - end - - def test_setup_generator - test_generator = Class.new do - def self.setup_options op - @op = op - end - - def self.op() @op end - end - - RDoc::RDoc::GENERATORS['test'] = test_generator - - @options.setup_generator 'test' - - assert_equal test_generator, @options.generator - assert_equal [test_generator], @options.generator_options - - assert_equal @options, test_generator.op - ensure - RDoc::RDoc::GENERATORS.delete 'test' - end - - def test_setup_generator_no_option_parser - test_generator = Class.new do - def self.setup_options op - op.option_parser.separator nil - @op = op - end - - def self.op() @op end - end - - RDoc::RDoc::GENERATORS['test'] = test_generator - - @options.setup_generator 'test' - - assert_equal test_generator, @options.generator - assert_equal [test_generator], @options.generator_options - - assert_equal @options, test_generator.op - ensure - RDoc::RDoc::GENERATORS.delete 'test' - end - - def test_update_output_dir - assert @options.update_output_dir - - @options.update_output_dir = false - - refute @options.update_output_dir - end - - def test_warn - out, err = capture_output do - @options.warn "warnings off" - end - - assert_empty out - assert_empty err - - @options.verbosity = 2 - - out, err = verbose_capture_output do - @options.warn "warnings on" - end - - assert_empty out - assert_equal "warnings on\n", err - end - - def test_write_options - temp_dir do |dir| - @options.write_options - - assert File.exist? '.rdoc_options' - - options = File.read('.rdoc_options') - options = YAML.safe_load(options, permitted_classes: [Symbol]) - assert_equal @options, RDoc::Options.new(options) - end - end - - def test_version - out, _ = capture_output do - begin - @options.parse %w[--version] - rescue SystemExit - end - end - - assert out.include?(RDoc::VERSION) - - out, _ = capture_output do - begin - @options.parse %w[-v] - rescue SystemExit - end - end - - assert out.include?(RDoc::VERSION) - end - - def test_visibility - @options.visibility = :all - assert_equal :private, @options.visibility - end - - def test_load_options - temp_dir do - options = RDoc::Options.new - options.markup = 'tomdoc' - options.write_options - - options = RDoc::Options.load_options - - assert_equal 'tomdoc', options.markup - end - end - - def test_load_options_invalid - temp_dir do - File.open '.rdoc_options', 'w' do |io| - io.write "a: !ruby.yaml.org,2002:str |\nfoo" - end - - e = assert_raise RDoc::Error do - RDoc::Options.load_options - end - - options_file = File.expand_path '.rdoc_options' - assert_equal "#{options_file} is not a valid rdoc options file", e.message - end - end - - def test_load_options_empty_file - temp_dir do - File.open '.rdoc_options', 'w' do |io| - end - - options = RDoc::Options.load_options - - assert_equal 'rdoc', options.markup - end - end - - def test_load_options_partial_override - temp_dir do - File.open '.rdoc_options', 'w' do |io| - io.puts "markup: Markdown" - io.puts "encoding: iso-8859-1" - io.puts "static_path: [static]" - io.puts "rdoc_include: [.]" - io.puts "page_dir: pages" - end - - options = RDoc::Options.load_options - - assert_equal 'Markdown', options.markup - assert_equal Encoding::ISO_8859_1, options.encoding - assert_equal ["static"], options.static_path - assert_equal ["."], options.rdoc_include - assert_equal "pages", options.page_dir - end - end - - def test_load_options_no_file - temp_dir do - options = RDoc::Options.load_options - - assert_kind_of RDoc::Options, options - end - end - - def test_skip_test_default_value - @options.parse %w[] - assert_equal true, @options.skip_tests - end - - def test_no_skip_test_value - @options.parse %w[--no-skipping-tests] - assert_equal false, @options.skip_tests - end - - def test_apply_default_exclude_option - @options.parse %w[] - exclude = @options.exclude - assert_kind_of Regexp, exclude - assert_match exclude, "foo~" - assert_match exclude, "foo.orig" - assert_match exclude, "foo.rej" - assert_match exclude, "foo.bak" - assert_match exclude, "foo.gemspec" - end - - def test_no_apply_default_exclude_option - @options.parse %w[--no-apply-default-exclude] - assert_nil @options.exclude - end - - def test_exclude_option_without_default - @options.parse %w[--no-apply-default-exclude --exclude=\.old\z] - exclude = @options.exclude - assert_match exclude, "foo.old" - assert_not_match exclude, "foo~" - end - - class DummyCoder < Hash - alias add :[]= - def tag=(tag) - end - end -end diff --git a/test/rdoc/test_rdoc_parser.rb b/test/rdoc/test_rdoc_parser.rb deleted file mode 100644 index 51a16ce361..0000000000 --- a/test/rdoc/test_rdoc_parser.rb +++ /dev/null @@ -1,334 +0,0 @@ -# -*- coding: us-ascii -*- -# frozen_string_literal: true - -require_relative 'helper' - -class RDocParserTest < RDoc::TestCase - def setup - super - - @RP = RDoc::Parser - @binary_dat_fixture_path = File.expand_path '../binary.dat', __FILE__ - @options = RDoc::Options.new - end - - def test_class_binary_eh_ISO_2022_JP - iso_2022_jp = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.rd" - - File.open iso_2022_jp, 'wb' do |io| - io.write "# coding: ISO-2022-JP\n" - io.write ":\e$B%3%^%s%I\e(B:\n" - end - - refute @RP.binary? iso_2022_jp - ensure - File.unlink iso_2022_jp - end - - def test_class_binary_eh_marshal - marshal = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.marshal" - File.open marshal, 'wb' do |io| - io.write Marshal.dump('') - io.write 'lots of text ' * 500 - end - - assert @RP.binary?(marshal) - ensure - File.unlink marshal - end - - def test_class_binary_japanese_text - file_name = File.expand_path '../test.ja.txt', __FILE__ - refute @RP.binary?(file_name) - end - - def test_class_binary_large_japanese_rdoc - capture_output do - begin - extenc, Encoding.default_external = - Encoding.default_external, Encoding::US_ASCII - file_name = File.expand_path '../test.ja.largedoc', __FILE__ - assert !@RP.binary?(file_name) - ensure - Encoding.default_external = extenc - end - end - end - - def test_class_binary_japanese_rdoc - file_name = File.expand_path '../test.ja.rdoc', __FILE__ - refute @RP.binary?(file_name) - end - - def test_class_can_parse - assert_equal @RP.can_parse(__FILE__), @RP::Ruby - - readme_file_name = File.expand_path '../test.txt', __FILE__ - - assert_equal @RP::Simple, @RP.can_parse(readme_file_name) - - assert_equal @RP::Simple, @RP.can_parse(@binary_dat_fixture_path) - - jtest_file_name = File.expand_path '../test.ja.txt', __FILE__ - assert_equal @RP::Simple, @RP.can_parse(jtest_file_name) - - jtest_rdoc_file_name = File.expand_path '../test.ja.rdoc', __FILE__ - assert_equal @RP::Simple, @RP.can_parse(jtest_rdoc_file_name) - - readme_file_name = File.expand_path '../README', __FILE__ - assert_equal @RP::Simple, @RP.can_parse(readme_file_name) - - jtest_largerdoc_file_name = File.expand_path '../test.ja.largedoc', __FILE__ - assert_equal @RP::Simple, @RP.can_parse(jtest_largerdoc_file_name) - - @RP.alias_extension 'rdoc', 'largedoc' - assert_equal @RP::Simple, @RP.can_parse(jtest_largerdoc_file_name) - end - - def test_class_for_executable - with_top_level("app", "#!/usr/bin/env ruby -w\n") do |top_level, content| - parser = @RP.for top_level, content, @options, :stats - - assert_kind_of RDoc::Parser::Ruby, parser - - assert_equal top_level.absolute_name, parser.file_name - end - end - - def test_class_for_forbidden - omit 'chmod not supported' if Gem.win_platform? - - tf = Tempfile.open 'forbidden' do |io| - begin - File.chmod 0000, io.path - forbidden = @store.add_file io.path - - parser = @RP.for forbidden, '', @options, :stats - - assert_nil parser - ensure - File.chmod 0400, io.path - end - io - end - tf.close! - end - - def test_class_for_modeline - with_top_level("NEWS", "# -*- rdoc -*-\n= NEWS\n") do |top_level, content| - parser = @RP.for top_level, content, @options, :stats - - assert_kind_of RDoc::Parser::Simple, parser - - assert_equal "= NEWS\n", parser.content - end - end - - def test_can_parse_modeline - readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}" - - File.open readme_ext, 'w' do |io| - io.puts "# README.EXT - -*- rdoc -*- created at: Mon Aug 7 16:45:54 JST 1995" - io.puts - io.puts "This document explains how to make extension libraries for Ruby." - end - - assert_equal RDoc::Parser::Simple, @RP.can_parse(readme_ext) - ensure - File.unlink readme_ext - end - - def test_can_parse_modeline_c - readme_inc = File.join Dir.tmpdir, "README.inc.#{$$}" - - File.open readme_inc, 'w' do |io| - io.puts "/* README.inc - -*- c -*- created at: Mon Aug 7 16:45:54 JST 1995 */" - io.puts - io.puts "/* This document explains how to make extension libraries for Ruby. */" - end - - assert_equal RDoc::Parser::C, @RP.can_parse(readme_inc) - ensure - File.unlink readme_inc - end - - ## - # Selenium hides a .jar file using a .txt extension. - - def test_class_can_parse_zip - hidden_zip = File.expand_path '../hidden.zip.txt', __FILE__ - assert_nil @RP.can_parse(hidden_zip) - end - - def test_check_modeline - readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}" - - File.open readme_ext, 'w' do |io| - io.puts "# README.EXT - -*- RDoc -*- created at: Mon Aug 7 16:45:54 JST 1995" - io.puts - io.puts "This document explains how to make extension libraries for Ruby." - end - - assert_equal 'rdoc', @RP.check_modeline(readme_ext) - ensure - File.unlink readme_ext - end - - def test_check_modeline_coding - readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}" - - File.open readme_ext, 'w' do |io| - io.puts "# -*- coding: utf-8 -*-" - end - - assert_nil @RP.check_modeline readme_ext - ensure - File.unlink readme_ext - end - - def test_check_modeline_with_other - readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}" - - File.open readme_ext, 'w' do |io| - io.puts "# README.EXT - -*- mode: RDoc; indent-tabs-mode: nil -*-" - io.puts - io.puts "This document explains how to make extension libraries for Ruby." - end - - assert_equal 'rdoc', @RP.check_modeline(readme_ext) - ensure - File.unlink readme_ext - end - - def test_check_modeline_no_modeline - readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}" - - File.open readme_ext, 'w' do |io| - io.puts "This document explains how to make extension libraries for Ruby." - end - - assert_nil @RP.check_modeline(readme_ext) - ensure - File.unlink readme_ext - end - - def test_class_for_binary - dat_fixture = File.read(@binary_dat_fixture_path) - with_top_level("binary.dat", dat_fixture) do |top_level, content| - assert_nil @RP.for(top_level, content, @options, nil) - end - end - - def test_class_for_markup - with_top_level("file.rb", "# coding: utf-8 markup: rd") do |top_level, content| - parser = @RP.for top_level, content, @options, nil - - assert_kind_of @RP::RD, parser - end - end - - def test_class_use_markup - content = <<-CONTENT -# coding: utf-8 markup: rd - CONTENT - - parser = @RP.use_markup content - - assert_equal @RP::RD, parser - end - - def test_class_use_markup_markdown - content = <<-CONTENT -# coding: utf-8 markup: markdown - CONTENT - - parser = @RP.use_markup content - - assert_equal @RP::Ruby, parser - end - - def test_class_use_markup_modeline - content = <<-CONTENT -# -*- coding: utf-8 -*- -# markup: rd - CONTENT - - parser = @RP.use_markup content - - assert_equal @RP::RD, parser - end - - def test_class_use_markup_modeline_shebang - content = <<-CONTENT -#!/bin/sh -/* -*- coding: utf-8 -*- - * markup: rd - */ - CONTENT - - parser = @RP.use_markup content - - assert_equal @RP::RD, parser - end - - def test_class_use_markup_shebang - content = <<-CONTENT -#!/usr/bin/env ruby -# coding: utf-8 markup: rd - CONTENT - - parser = @RP.use_markup content - - assert_equal @RP::RD, parser - end - - def test_class_use_markup_tomdoc - content = <<-CONTENT -# coding: utf-8 markup: tomdoc - CONTENT - - parser = @RP.use_markup content - - assert_equal @RP::Ruby, parser - end - - def test_class_use_markup_none - parser = @RP.use_markup '' - - assert_nil parser - end - - def test_class_use_markup_unknown - content = <<-CONTENT -# :markup: RDoc - CONTENT - - parser = @RP.use_markup content - - assert_nil parser - end - - def test_initialize - with_top_level("file.rb", "") do |top_level, content| - @RP.new top_level, top_level.absolute_name, content, @options, nil - - assert_equal @RP, top_level.parser - end - end - - private - - def with_top_level(filename, content, &block) - absoluate_filename = File.join Dir.tmpdir, filename - File.open absoluate_filename, 'w' do |io| - io.write content - end - - top_level = RDoc::TopLevel.new absoluate_filename - - yield(top_level, content) - ensure - File.unlink absoluate_filename - end - -end diff --git a/test/rdoc/test_rdoc_parser_c.rb b/test/rdoc/test_rdoc_parser_c.rb deleted file mode 100644 index 31702a7cd0..0000000000 --- a/test/rdoc/test_rdoc_parser_c.rb +++ /dev/null @@ -1,2150 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -=begin - TODO: test call-seq parsing - -/* - * call-seq: - * ARGF.readlines(sep=$/) -> array - * ARGF.readlines(limit) -> array - * ARGF.readlines(sep, limit) -> array - * - * ARGF.to_a(sep=$/) -> array - * ARGF.to_a(limit) -> array - * ARGF.to_a(sep, limit) -> array - * - * Reads +ARGF+'s current file in its entirety, returning an +Array+ of its - * lines, one line per element. Lines are assumed to be separated by _sep_. - * - * lines = ARGF.readlines - * lines[0] #=> "This is line one\n" - */ - -assert call-seq did not stop at first empty line - -/* - * call-seq: - * - * flt ** other -> float - * - * Raises <code>float</code> the <code>other</code> power. - * - * 2.0**3 #=> 8.0 - */ - -assert call-seq correct (bug: was empty) - -/* call-seq: flt ** other -> float */ - -assert call-seq correct - -=end - -class TestRDocParserC < RDoc::TestCase - - def setup - super - - @tempfile = Tempfile.new self.class.name - filename = @tempfile.path - - @top_level = @store.add_file filename - @fn = filename - @options = RDoc::Options.new - @options.verbosity = 2 - @stats = RDoc::Stats.new @store, 0 - end - - def teardown - super - - @tempfile.close! - end - - def test_class_can_parse - c_parser = RDoc::Parser::C - - temp_dir do - FileUtils.touch 'file.C' - assert_equal c_parser, c_parser.can_parse('file.C') - - FileUtils.touch 'file.CC' - assert_equal c_parser, c_parser.can_parse('file.CC') - - FileUtils.touch 'file.H' - assert_equal c_parser, c_parser.can_parse('file.H') - - FileUtils.touch 'file.HH' - assert_equal c_parser, c_parser.can_parse('file.HH') - - FileUtils.touch 'file.c' - assert_equal c_parser, c_parser.can_parse('file.c') - - FileUtils.touch 'file.cc' - assert_equal c_parser, c_parser.can_parse('file.cc') - - FileUtils.touch 'file.cpp' - assert_equal c_parser, c_parser.can_parse('file.cpp') - - FileUtils.touch 'file.cxx' - assert_equal c_parser, c_parser.can_parse('file.cxx') - - FileUtils.touch 'file.h' - assert_equal c_parser, c_parser.can_parse('file.h') - - FileUtils.touch 'file.hh' - assert_equal c_parser, c_parser.can_parse('file.hh') - - FileUtils.touch 'file.y' - assert_equal c_parser, c_parser.can_parse('file.y') - end - end - - def test_known_classes - RDoc::KNOWN_CLASSES.each do |var, name| - case name - when "Refinement" - next unless defined?(Refinement) - when "RubyVM" - next unless defined?(RubyVM) - when "Bignum", "Fixnum", "Data", "Socket", /\A(?![A-Z])/ - next - end - obj = Object.const_get(name) - assert_equal obj.name, name - case var - when /\Arb_c/ - assert_kind_of Class, obj - when /\Arb_m/ - assert_kind_of Module, obj - when /\Arb_e/ - assert_operator obj, :<=, Exception - else - raise "unknown prefix: #{var} => #{name}" - end - end - end - - def test_initialize - some_ext = @top_level.add_class RDoc::NormalClass, 'SomeExt' - @top_level.add_class RDoc::SingleClass, 'SomeExtSingle' - - @store.cache[:c_class_variables] = { - @fn => { 'cSomeExt' => 'SomeExt' } - } - - @store.cache[:c_singleton_class_variables] = { - @fn => { 'cSomeExtSingle' => 'SomeExtSingle' } - } - - parser = RDoc::Parser::C.new @top_level, @fn, '', @options, @stats - - expected = { 'cSomeExt' => some_ext } - assert_equal expected, parser.classes - - expected = { 'cSomeExtSingle' => 'SomeExtSingle' } - assert_equal expected, parser.singleton_classes - - expected = { - 'cSomeExt' => 'SomeExt', - 'cSomeExtSingle' => 'SomeExtSingle', - } - known_classes = parser.known_classes.delete_if do |key, _| - RDoc::KNOWN_CLASSES.keys.include? key - end - - assert_equal expected, known_classes - end - - def assert_do_attr(flags) - content = <<-EOF -void Init_Blah(void) { - cBlah = rb_define_class("Blah", rb_cObject); - - /* - * This is an accessor - */ - #{yield "cBlah", "accessor", flags[1], flags[1]}; - - /* - * This is a reader - */ - #{yield "cBlah", "reader", flags[1], flags[0]}; - - /* - * This is a writer - */ - #{yield "cBlah", "writer", flags[0], flags[1]}; -} - EOF - - klass = util_get_class content, 'cBlah' - - attrs = klass.attributes - assert_equal 3, attrs.length, attrs.inspect - - accessor = attrs.shift - assert_equal 'accessor', accessor.name - assert_equal 'RW', accessor.rw - assert_equal 'This is an accessor', accessor.comment.text - assert_equal @top_level, accessor.file - - reader = attrs.shift - assert_equal 'reader', reader.name - assert_equal 'R', reader.rw - assert_equal 'This is a reader', reader.comment.text - - writer = attrs.shift - assert_equal 'writer', writer.name - assert_equal 'W', writer.rw - assert_equal 'This is a writer', writer.comment.text - end - - { - num: %w[0 1], - macro: %w[FALSE TRUE], - ruby: %w[Qfalse Qtrue], - bool: %w[false true], - }.each_pair do |name, values| - define_method("test_do_attr:rb_attr:intern:#{name}") do - assert_do_attr(values) {|c, name, r, w| %[rb_attr(#{c}, rb_intern("#{name}"), #{r}, #{w}, Qfalse)]} - end - define_method("test_do_attr:rb_attr:intern_const:#{name}") do - assert_do_attr(values) {|c, name, r, w| %[rb_attr(#{c}, rb_intern_const("#{name}"), #{r}, #{w}, Qfalse)]} - end - define_method("test_do_attr:rb_define_attr:#{name}") do - assert_do_attr(values) {|c, name, r, w| %[rb_define_attr(#{c}, "#{name}", #{r}, #{w})]} - end - end - - def test_do_aliases - content = <<-EOF -/* - * This should show up as an alias with documentation - */ -VALUE blah(VALUE klass, VALUE year) { -} - -void Init_Blah(void) { - cDate = rb_define_class("Date", rb_cObject); - - rb_define_method(cDate, "blah", blah, 1); - - rb_define_alias(cDate, "bleh", "blah"); -} - EOF - - klass = util_get_class content, 'cDate' - - methods = klass.method_list - assert_equal 2, methods.length - assert_equal 'bleh', methods.last.name - assert_equal 'blah', methods.last.is_alias_for.name - - assert_equal @top_level, methods.last.is_alias_for.file - assert_equal @top_level, methods.last.file - end - - def test_do_aliases_singleton - content = <<-EOF -/* - * This should show up as a method with documentation - */ -VALUE blah(VALUE klass, VALUE year) { -} - -void Init_Blah(void) { - cDate = rb_define_class("Date", rb_cObject); - sDate = rb_singleton_class(cDate); - - rb_define_method(sDate, "blah", blah, 1); - - /* - * This should show up as an alias - */ - rb_define_alias(sDate, "bleh", "blah"); -} - EOF - - klass = util_get_class content, 'cDate' - - methods = klass.method_list - - assert_equal 2, methods.length - assert_equal 'bleh', methods.last.name - assert methods.last.singleton - assert_equal 'blah', methods.last.is_alias_for.name - assert_equal 'This should show up as an alias', methods.last.comment.text - end - - def test_do_aliases_missing_class - content = <<-EOF -void Init_Blah(void) { - rb_define_alias(cDate, "b", "a"); -} - EOF - - _, err = verbose_capture_output do - refute util_get_class(content, 'cDate') - end - - assert_equal "Enclosing class or module \"cDate\" for alias b a is not known\n", - err - end - - def test_do_classes_class - content = <<-EOF -/* Document-class: Foo - * this is the Foo class - */ -VALUE cFoo = rb_define_class("Foo", rb_cObject); - EOF - - klass = util_get_class content, 'cFoo' - assert_equal "this is the Foo class", klass.comment.text - end - - def test_do_classes_duplicate_class - content = <<-EOF -/* Document-class: Foo - * first - */ -VALUE cFoo = rb_define_class("Foo", rb_cObject); -/* Document-class: Foo - * second - */ -VALUE cFoo = rb_define_class("Foo", rb_cObject); - EOF - - klass = util_get_class content, 'cFoo' - assert_equal 1, klass.comment_location.size - first = klass.comment_location.first - first_comment = first[0] - assert_equal 'first', first_comment.text - end - - def test_do_classes_struct - content = <<-EOF -/* Document-class: Foo - * this is the Foo class - */ -VALUE cFoo = rb_struct_define( - "Foo", - "some", "various", "fields", NULL); - EOF - - klass = util_get_class content, 'cFoo' - assert_equal "this is the Foo class", klass.comment.text - - attributes = klass.attributes - assert_equal 3, attributes.size, -> {attributes} - ["some", "various", "fields"].zip(attributes) do |name, attr| - assert_equal RDoc::Attr.new("", name, "RW", ""), attr - end - end - - def test_do_classes_struct_under - content = <<-EOF -/* Document-class: Kernel::Foo - * this is the Foo class under Kernel - */ -VALUE cFoo = rb_struct_define_under( - rb_mKernel, "Foo", - "some", "various", "fields", NULL); - EOF - - klass = util_get_class content, 'cFoo' - assert_equal 'Kernel::Foo', klass.full_name - assert_equal "this is the Foo class under Kernel", klass.comment.text - - attributes = klass.attributes - assert_equal 3, attributes.size, -> {attributes} - ["some", "various", "fields"].zip(attributes) do |name, attr| - assert_equal RDoc::Attr.new("", name, "RW", ""), attr - end - end - - def test_do_classes_struct_without_accessor - content = <<-EOF -/* Document-class: Foo - * this is the Foo class - */ -VALUE cFoo = rb_struct_define_without_accessor( - "Foo", rb_cObject, foo_alloc, - "some", "various", "fields", NULL); - EOF - - klass = util_get_class content, 'cFoo' - assert_equal "this is the Foo class", klass.comment.text - assert_empty klass.attributes - end - - def test_do_classes_struct_without_accessor_under - content = <<-EOF -/* Document-class: Kernel::Foo - * this is the Foo class under Kernel - */ -VALUE cFoo = rb_struct_define_without_accessor_under( - rb_mKernel, "Foo", rb_cObject, foo_alloc, - "some", "various", "fields", NULL); - EOF - - klass = util_get_class content, 'cFoo' - assert_equal 'Kernel::Foo', klass.full_name - assert_equal "this is the Foo class under Kernel", klass.comment.text - assert_empty klass.attributes - end - - def test_do_classes_class_under - content = <<-EOF -/* Document-class: Kernel::Foo - * this is the Foo class under Kernel - */ -VALUE cFoo = rb_define_class_under(rb_mKernel, "Foo", rb_cObject); - EOF - - klass = util_get_class content, 'cFoo' - assert_equal 'Kernel::Foo', klass.full_name - assert_equal "this is the Foo class under Kernel", klass.comment.text - end - - def test_do_classes_class_under_rb_path2class - content = <<-EOF -/* Document-class: Kernel::Foo - * this is Kernel::Foo < A::B - */ -VALUE cFoo = rb_define_class_under(rb_mKernel, "Foo", rb_path2class("A::B")); - EOF - - klass = util_get_class content, 'cFoo' - - assert_equal 'Kernel::Foo', klass.full_name - assert_equal 'A::B', klass.superclass - assert_equal 'this is Kernel::Foo < A::B', klass.comment.text - end - - def test_do_classes_singleton - content = <<-EOF -VALUE cFoo = rb_define_class("Foo", rb_cObject); -VALUE cFooS = rb_singleton_class(cFoo); - EOF - - util_get_class content, 'cFooS' - - assert_equal 'Foo', @parser.singleton_classes['cFooS'] - end - - def test_do_classes_module - content = <<-EOF -/* Document-module: Foo - * this is the Foo module - */ -VALUE mFoo = rb_define_module("Foo"); - EOF - - klass = util_get_class content, 'mFoo' - assert_equal "this is the Foo module", klass.comment.text - end - - def test_do_classes_module_under - content = <<-EOF -/* Document-module: Kernel::Foo - * this is the Foo module under Kernel - */ -VALUE mFoo = rb_define_module_under(rb_mKernel, "Foo"); - EOF - - klass = util_get_class content, 'mFoo' - assert_equal "this is the Foo module under Kernel", klass.comment.text - end - - def test_do_constants - content = <<-'EOF' -#include <ruby.h> - -void Init_foo(){ - VALUE cFoo = rb_define_class("Foo", rb_cObject); - - /* 300: The highest possible score in bowling */ - rb_define_const(cFoo, "PERFECT", INT2FIX(300)); - - /* Huzzah!: What you cheer when you roll a perfect game */ - rb_define_const(cFoo, "CHEER", rb_str_new2("Huzzah!")); - - /* TEST\:TEST: Checking to see if escaped colon works */ - rb_define_const(cFoo, "TEST", rb_str_new2("TEST:TEST")); - - /* TEST: TEST:Checking to see if only word-ending colon works */ - rb_define_const(cFoo, "TEST2", rb_str_new2("TEST:TEST")); - - /* \\: The file separator on MS Windows */ - rb_define_const(cFoo, "MSEPARATOR", rb_str_new2("\\")); - - /* /: The file separator on Unix */ - rb_define_const(cFoo, "SEPARATOR", rb_str_new2("/")); - - /* C:\\Program Files\\Stuff: A directory on MS Windows */ - rb_define_const(cFoo, "STUFF", rb_str_new2("C:\\Program Files\\Stuff")); - - /* Default definition */ - rb_define_const(cFoo, "NOSEMI", INT2FIX(99)); - - rb_define_const(cFoo, "NOCOMMENT", rb_str_new2("No comment")); - - /* - * Multiline comment goes here because this comment spans multiple lines. - * Multiline comment goes here because this comment spans multiple lines. - */ - rb_define_const(cFoo, "MULTILINE", INT2FIX(1)); - - /* - * 1: Multiline comment goes here because this comment spans multiple lines. - * Multiline comment goes here because this comment spans multiple lines. - */ - rb_define_const(cFoo, "MULTILINE_VALUE", INT2FIX(1)); - - /* Multiline comment goes here because this comment spans multiple lines. - * Multiline comment goes here because this comment spans multiple lines. - */ - rb_define_const(cFoo, "MULTILINE_NOT_EMPTY", INT2FIX(1)); - - /* - * Multiline comment goes here because this comment spans multiple lines. - * 1: However, the value extraction should only happen for the first line - */ - rb_define_const(cFoo, "MULTILINE_COLON_ON_SECOND_LINE", INT2FIX(1)); - -} - EOF - - @parser = util_parser content - - @parser.do_classes_and_modules - @parser.do_constants - - klass = @parser.classes['cFoo'] - assert klass - - constants = klass.constants - assert !klass.constants.empty? - - assert_equal @top_level, constants.first.file - - constants = constants.map { |c| [c.name, c.value, c.comment.text] } - - assert_equal ['PERFECT', '300', 'The highest possible score in bowling '], - constants.shift - assert_equal ['CHEER', 'Huzzah!', - 'What you cheer when you roll a perfect game '], - constants.shift - assert_equal ['TEST', 'TEST:TEST', - 'Checking to see if escaped colon works '], - constants.shift - assert_equal ['TEST2', 'TEST', - 'TEST:Checking to see if only word-ending colon works '], - constants.shift - assert_equal ['MSEPARATOR', '\\', - 'The file separator on MS Windows '], - constants.shift - assert_equal ['SEPARATOR', '/', - 'The file separator on Unix '], - constants.shift - assert_equal ['STUFF', 'C:\\Program Files\\Stuff', - 'A directory on MS Windows '], - constants.shift - assert_equal ['NOSEMI', 'INT2FIX(99)', - 'Default definition '], - constants.shift - assert_equal ['NOCOMMENT', 'rb_str_new2("No comment")', ''], - constants.shift - - comment = <<-EOF.chomp -Multiline comment goes here because this comment spans multiple lines. -Multiline comment goes here because this comment spans multiple lines. - EOF - assert_equal ['MULTILINE', 'INT2FIX(1)', comment], constants.shift - assert_equal ['MULTILINE_VALUE', '1', comment], constants.shift - assert_equal ['MULTILINE_NOT_EMPTY', 'INT2FIX(1)', comment], constants.shift - - comment = <<-EOF.chomp -Multiline comment goes here because this comment spans multiple lines. -1: However, the value extraction should only happen for the first line - EOF - assert_equal ['MULTILINE_COLON_ON_SECOND_LINE', 'INT2FIX(1)', comment], - constants.shift - - assert constants.empty?, constants.inspect - end - - def test_do_constants_global - content = <<-'EOF' -#include <ruby.h> - -void Init_foo(){ - - /* Toplevel const */ - rb_define_global_const("ANSWER", INT2FIX(42)); - -} - EOF - - @parser = util_parser content - - @parser.do_classes_and_modules - @parser.do_constants - - klass = @parser.classes['rb_cObject'] - assert klass - - constants = klass.constants - assert !klass.constants.empty? - - assert_equal @top_level, constants.first.file - - constants = constants.map { |c| [c.name, c.value, c.comment.text] } - assert_equal ['ANSWER', 'INT2FIX(42)', "Toplevel const "], - constants.shift - - assert constants.empty?, constants.inspect - end - - def test_do_constants_curses - content = <<-EOF -void Init_curses(){ - mCurses = rb_define_module("Curses"); - - /* - * Value of the color black - */ - rb_curses_define_const(COLOR_BLACK); -} - EOF - - @parser = util_parser content - - @parser.do_classes_and_modules - @parser.do_constants - - klass = @parser.classes['mCurses'] - - constants = klass.constants - refute_empty klass.constants - - assert_equal 'COLOR_BLACK', constants.first.name - assert_equal 'UINT2NUM(COLOR_BLACK)', constants.first.value - assert_equal 'Value of the color black', constants.first.comment.text - end - - def test_do_constants_file - content = <<-EOF -void Init_File(void) { - /* - * Shared lock - */ - rb_file_const("LOCK_SH", INT2FIX(LOCK_SH)); -} - EOF - - @parser = util_parser content - - @parser.do_classes_and_modules - @parser.do_constants - - klass = @parser.classes['rb_mFConst'] - - constants = klass.constants - refute_empty klass.constants - - constant = constants.first - - assert_equal 'LOCK_SH', constant.name - assert_equal 'INT2FIX(LOCK_SH)', constant.value - assert_equal 'Shared lock', constant.comment.text - - @parser = util_parser <<-EOF -void Init_File(void) { - rb_cFile = rb_define_class("File", rb_cIO); - rb_mFConst = rb_define_module_under(rb_cFile, "Constants"); -} - EOF - @parser.do_classes_and_modules - @parser.do_constants - - assert_equal 'File::Constants', klass.full_name - end - - def test_do_includes - content = <<-EOF -Init_foo() { - VALUE cFoo = rb_define_class("Foo", rb_cObject); - VALUE mInc = rb_define_module("Inc"); - - rb_include_module(cFoo, mInc); -} - EOF - - klass = util_get_class content, 'cFoo' - - incl = klass.includes.first - assert_equal 'Inc', incl.name - assert_equal '', incl.comment.text - assert_equal @top_level, incl.file - end - - # HACK parsing warning instead of setting up in file - def test_do_methods_in_c - content = <<-EOF -VALUE blah(VALUE klass, VALUE year) { -} - -void Init_Blah(void) { - cDate = rb_define_class("Date", rb_cObject); - - rb_define_method(cDate, "blah", blah, 1); /* in blah.c */ -} - EOF - - klass = nil - - _, err = verbose_capture_output do - klass = util_get_class content, 'cDate' - end - - assert_equal 'Date', klass.full_name - assert_match ' blah.c ', err - end - - # HACK parsing warning instead of setting up in file - def test_do_methods_in_cpp - content = <<-EOF -VALUE blah(VALUE klass, VALUE year) { -} - -void Init_Blah(void) { - cDate = rb_define_class("Date", rb_cObject); - - rb_define_method(cDate, "blah", blah, 1); /* in blah.cpp */ -} - EOF - - klass = nil - - _, err = verbose_capture_output do - klass = util_get_class content, 'cDate' - end - - assert_equal 'Date', klass.full_name - assert_match ' blah.cpp ', err - end - - # HACK parsing warning instead of setting up in file - def test_do_methods_in_y - content = <<-EOF -VALUE blah(VALUE klass, VALUE year) { -} - -void Init_Blah(void) { - cDate = rb_define_class("Date", rb_cObject); - - rb_define_method(cDate, "blah", blah, 1); /* in blah.y */ -} - EOF - - klass = nil - - _, err = verbose_capture_output do - klass = util_get_class content, 'cDate' - end - - assert_equal 'Date', klass.full_name - assert_match ' blah.y ', err - end - - def test_do_methods_singleton_class - content = <<-EOF -VALUE blah(VALUE klass, VALUE year) { -} - -void Init_Blah(void) { - cDate = rb_define_class("Date", rb_cObject); - sDate = rb_singleton_class(cDate); - - rb_define_method(sDate, "blah", blah, 1); -} - EOF - - klass = util_get_class content, 'cDate' - - methods = klass.method_list - assert_equal 1, methods.length - assert_equal 'blah', methods.first.name - assert methods.first.singleton - end - - def test_do_missing - parser = util_parser - - klass_a = @top_level.add_class RDoc::ClassModule, 'A' - parser.classes['a'] = klass_a - - parser.enclosure_dependencies['c'] << 'b' - parser.enclosure_dependencies['b'] << 'a' - parser.enclosure_dependencies['d'] << 'a' - - parser.missing_dependencies['d'] = ['d', :class, 'D', 'Object', 'a'] - parser.missing_dependencies['c'] = ['c', :class, 'C', 'Object', 'b'] - parser.missing_dependencies['b'] = ['b', :class, 'B', 'Object', 'a'] - - parser.do_missing - - assert_equal %w[A A::B A::B::C A::D], - @store.all_classes_and_modules.map { |m| m.full_name }.sort - end - - def test_do_missing_cycle - parser = util_parser - - klass_a = @top_level.add_class RDoc::ClassModule, 'A' - parser.classes['a'] = klass_a - - parser.enclosure_dependencies['c'] << 'b' - parser.enclosure_dependencies['b'] << 'a' - - parser.missing_dependencies['c'] = ['c', :class, 'C', 'Object', 'b'] - parser.missing_dependencies['b'] = ['b', :class, 'B', 'Object', 'a'] - - parser.enclosure_dependencies['y'] << 'z' - parser.enclosure_dependencies['z'] << 'y' - - parser.missing_dependencies['y'] = ['y', :class, 'Y', 'Object', 'z'] - parser.missing_dependencies['z'] = ['z', :class, 'Z', 'Object', 'y'] - - _, err = verbose_capture_output do - parser.do_missing - end - - expected = 'Unable to create class Y (y), class Z (z) ' + - 'due to a cyclic class or module creation' - - assert_equal expected, err.chomp - - assert_equal %w[A A::B A::B::C], - @store.all_classes_and_modules.map { |m| m.full_name }.sort - end - - def test_find_alias_comment - parser = util_parser - - comment = parser.find_alias_comment 'C', '[]', 'index' - - assert_equal '', comment.text - - parser = util_parser <<-C -/* - * comment - */ - -rb_define_alias(C, "[]", "index"); - C - - comment = parser.find_alias_comment 'C', '[]', 'index' - - assert_equal "/*\n * comment\n */\n\n", comment.text - end - - def test_find_attr_comment_document_attr - parser= util_parser <<-C -/* - * Document-attr: y - * comment - */ - C - - comment = parser.find_attr_comment nil, 'y' - - assert_equal "/*\n * \n * comment\n */", comment.text - end - - def test_find_attr_comment_document_attr_oneline - parser= util_parser <<-C -/* Document-attr: y - * comment - */ - C - - comment = parser.find_attr_comment nil, 'y' - - assert_equal "/* \n * comment\n */", comment.text - end - - def test_find_attr_comment_document_attr_overlap - parser= util_parser <<-C -/* Document-attr: x - * comment - */ - -/* Document-attr: y - * comment - */ - C - - comment = parser.find_attr_comment nil, 'y' - - assert_equal "/* \n * comment\n */", comment.text - end - - def test_find_class_comment - @options.rdoc_include << File.dirname(__FILE__) - - content = <<-EOF -/* - * Comment 1 - */ -foo = rb_define_class("MyClassName1", rb_cObject); - -/* - * Comment 2 - */ -bar = rb_define_class("MyClassName2", rb_cObject); - EOF - - util_get_class content - - assert_equal "Comment 1", @parser.classes['foo'].comment.text - assert_equal "Comment 2", @parser.classes['bar'].comment.text - end - - def test_find_class_comment_init - content = <<-EOF -/* - * a comment for class Foo - */ -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); -} - EOF - - klass = util_get_class content, 'foo' - - assert_equal "a comment for class Foo", klass.comment.text - end - - - def test_find_class_comment_initvm - content = <<-EOF -/* - * a comment for class Foo - */ -void -InitVM_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); -} - EOF - - klass = util_get_class content, 'foo' - - assert_equal "a comment for class Foo", klass.comment.text - end - - def test_find_class_comment_define_class - content = <<-EOF -/* - * a comment for class Foo - */ -VALUE foo = rb_define_class("Foo", rb_cObject); - EOF - - klass = util_get_class content, 'foo' - - assert_equal "a comment for class Foo", klass.comment.text - end - - def test_find_class_comment_define_class_Init_Foo - content = <<-EOF -/* - * a comment for class Foo on Init - */ -void -Init_Foo(void) { - /* - * a comment for class Foo on rb_define_class - */ - VALUE foo = rb_define_class("Foo", rb_cObject); -} - EOF - - klass = util_get_class content, 'foo' - - assert_equal "a comment for class Foo on Init", klass.comment.text - end - - def test_find_class_comment_define_class_Init_Foo_no_void - content = <<-EOF -/* - * a comment for class Foo on Init - */ -void -Init_Foo() { - /* - * a comment for class Foo on rb_define_class - */ - VALUE foo = rb_define_class("Foo", rb_cObject); -} - EOF - - klass = util_get_class content, 'foo' - - assert_equal "a comment for class Foo on Init", klass.comment.text - end - - def test_find_class_comment_define_class_bogus_comment - content = <<-EOF -/* - * a comment for other_function - */ -void -other_function() { -} - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); -} - EOF - - klass = util_get_class content, 'foo' - - assert_equal '', klass.comment.text - end - - def test_find_class_comment_define_class_under - content = <<-EOF -/* - * a comment for class Foo - */ -VALUE foo = rb_define_class_under(rb_cObject, "Foo", rb_cObject); - EOF - - klass = util_get_class content, 'foo' - - assert_equal "a comment for class Foo", klass.comment.text - end - - def test_find_class_comment_define_class_under_Init - content = <<-EOF -/* - * a comment for class Foo on Init - */ -void -Init_Foo(void) { - /* - * a comment for class Foo on rb_define_class - */ - VALUE foo = rb_define_class_under(rb_cObject, "Foo", rb_cObject); -} - EOF - - klass = util_get_class content, 'foo' - - # the inner comment is used since Object::Foo is not necessarily the same - # thing as "Foo" for Init_ - assert_equal "a comment for class Foo on rb_define_class", - klass.comment.text - end - - def test_find_const_comment_rb_define - content = <<-EOF -/* - * A comment - */ -rb_define_const(cFoo, "CONST", value); - EOF - - parser = util_parser content - - comment = parser.find_const_comment 'const', 'CONST' - - assert_equal "/*\n * A comment\n */\n", comment.text - end - - def test_find_const_comment_rb_define_global - content = <<-EOF -/* - * A comment - */ -rb_define_global_const("CONST", value); - EOF - - parser = util_parser content - - comment = parser.find_const_comment 'const', 'CONST' - - assert_equal "/*\n * A comment\n */\n", comment.text - end - - def test_find_const_comment_document_const - content = <<-EOF -/* - * Document-const: CONST - * - * A comment - */ - EOF - - parser = util_parser content - - comment = parser.find_const_comment nil, 'CONST' - - assert_equal "/*\n *\n * A comment\n */", comment.text - end - - def test_find_const_comment_document_const_full_name - content = <<-EOF -/* - * Document-const: Foo::CONST - * - * A comment - */ - EOF - - parser = util_parser content - - comment = parser.find_const_comment nil, 'CONST', 'Foo' - - assert_equal "/*\n *\n * A comment\n */", comment.text - end - - def test_find_body - content = <<-EOF -/* - * a comment for other_function - */ -VALUE -other_function() { -} - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); - - rb_define_method(foo, "my_method", other_function, 0); -} - EOF - - klass = util_get_class content, 'foo' - other_function = klass.method_list.first - - assert_equal 'my_method', other_function.name - assert_equal "a comment for other_function", - other_function.comment.text - assert_equal '()', other_function.params - - code = other_function.token_stream.first[:text] - - assert_equal "VALUE\nother_function() {\n}", code - end - - def test_find_body_2 - content = <<-CONTENT -/* Copyright (C) 2010 Sven Herzberg - * - * This file is free software; the author(s) gives unlimited - * permission to copy and/or distribute it, with or without - * modifications, as long as this notice is preserved. - */ - -#include <ruby.h> - -static VALUE -wrap_initialize (VALUE self) -{ - return self; -} - -/* */ -static VALUE -wrap_shift (VALUE self, - VALUE arg) -{ - return self; -} - -void -init_gi_repository (void) -{ - VALUE mTest = rb_define_module ("Test"); - VALUE cTest = rb_define_class_under (mTest, "Test", rb_cObject); - - rb_define_method (cTest, "initialize", wrap_initialize, 0); - rb_define_method (cTest, "shift", wrap_shift, 0); -} - CONTENT - - klass = util_get_class content, 'cTest' - assert_equal 2, klass.method_list.length - end - - def test_find_body_cast - content = <<-EOF -/* - * a comment for other_function - */ -VALUE -other_function() { -} - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); - - rb_define_method(foo, "my_method", (METHOD)other_function, 0); -} - EOF - - klass = util_get_class content, 'foo' - other_function = klass.method_list.first - - assert_equal 'my_method', other_function.name - assert_equal "a comment for other_function", - other_function.comment.text - assert_equal '()', other_function.params - - code = other_function.token_stream.first[:text] - - assert_equal "VALUE\nother_function() {\n}", code - end - - def test_find_body_define - content = <<-EOF -#define something something_else - -#define other_function rb_other_function - -/* - * a comment for rb_other_function - */ -VALUE -rb_other_function() { -} - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); - - rb_define_method(foo, "my_method", other_function, 0); -} - EOF - - klass = util_get_class content, 'foo' - other_function = klass.method_list.first - - assert_equal 'my_method', other_function.name - assert_equal 'a comment for rb_other_function', other_function.comment.text - assert_equal '()', other_function.params - assert_equal 8, other_function.line - - code = other_function.token_stream.first[:text] - - assert_equal "VALUE\nrb_other_function() {\n}", code - end - - def test_find_body_define_comment - content = <<-EOF -/* - * a comment for other_function - */ -#define other_function rb_other_function - -/* */ -VALUE -rb_other_function() { -} - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); - - rb_define_method(foo, "my_method", other_function, 0); -} - EOF - - klass = util_get_class content, 'foo' - other_function = klass.method_list.first - - assert_equal 'my_method', other_function.name - assert_equal 'a comment for other_function', other_function.comment.text - assert_equal '()', other_function.params - assert_equal 4, other_function.line - - code = other_function.token_stream.first[:text] - - assert_equal "#define other_function rb_other_function", code - end - - def test_find_body_document_method - content = <<-EOF -/* - * Document-method: bar - * Document-method: baz - * - * a comment for bar - */ -VALUE -bar() { -} - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); - - rb_define_method(foo, "bar", bar, 0); - rb_define_method(foo, "baz", bar, 0); -} - EOF - - klass = util_get_class content, 'foo' - assert_equal 2, klass.method_list.length - - methods = klass.method_list.sort - - bar = methods.first - assert_equal 'Foo#bar', bar.full_name - assert_equal "a comment for bar", bar.comment.text - - baz = methods.last - assert_equal 'Foo#baz', baz.full_name - assert_equal "a comment for bar", baz.comment.text - end - - def test_find_body_document_method_equals - content = <<-EOF -/* - * Document-method: Zlib::GzipFile#mtime= - * - * A comment - */ -static VALUE -rb_gzfile_set_mtime(VALUE obj, VALUE mtime) -{ - -void -Init_zlib() { - mZlib = rb_define_module("Zlib"); - cGzipFile = rb_define_class_under(mZlib, "GzipFile", rb_cObject); - cGzipWriter = rb_define_class_under(mZlib, "GzipWriter", cGzipFile); - rb_define_method(cGzipWriter, "mtime=", rb_gzfile_set_mtime, 1); -} - EOF - - klass = util_get_class content, 'cGzipWriter' - assert_equal 1, klass.method_list.length - - methods = klass.method_list.sort - - bar = methods.first - assert_equal 'Zlib::GzipWriter#mtime=', bar.full_name - assert_equal 'A comment', bar.comment.text - end - - def test_find_body_document_method_same - content = <<-EOF -VALUE -s_bar() { -} - -VALUE -bar() { -} - -/* - * Document-method: Foo::bar - * - * a comment for Foo::bar - */ - -/* - * Document-method: Foo#bar - * - * a comment for Foo#bar - */ - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); - - rb_define_singleton_method(foo, "bar", s_bar, 0); - rb_define_method(foo, "bar", bar, 0); -} - EOF - - klass = util_get_class content, 'foo' - assert_equal 2, klass.method_list.length - - methods = klass.method_list.sort - - s_bar = methods.first - assert_equal 'Foo::bar', s_bar.full_name - assert_equal "a comment for Foo::bar", s_bar.comment.text - - bar = methods.last - assert_equal 'Foo#bar', bar.full_name - assert_equal "a comment for Foo#bar", bar.comment.text - end - - def test_find_body_macro - content = <<-EOF -/* - * a comment for other_function - */ -DLL_LOCAL VALUE -other_function() { -} - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); - - rb_define_method(foo, "my_method", other_function, 0); -} - EOF - - klass = util_get_class content, 'foo' - other_function = klass.method_list.first - - assert_equal 'my_method', other_function.name - assert_equal "a comment for other_function", - other_function.comment.text - assert_equal '()', other_function.params - - code = other_function.token_stream.first[:text] - - assert_equal "DLL_LOCAL VALUE\nother_function() {\n}", code - end - - def test_find_body_static_inline - content = <<-EOF -/* - * a comment for other_function - */ -static inline VALUE -other_function() { -} - -void -Init_Foo(void) { - VALUE foo = rb_define_class("Foo", rb_cObject); - - rb_define_method(foo, "my_method", other_function, 0); -} - EOF - - klass = util_get_class content, 'foo' - other_function = klass.method_list.first - - assert_equal 'my_method', other_function.name - assert_equal "a comment for other_function", - other_function.comment.text - assert_equal '()', other_function.params - - code = other_function.token_stream.first[:text] - - assert_equal "static inline VALUE\nother_function() {\n}", code - end - - def test_find_modifiers_call_seq - comment = RDoc::Comment.new <<-COMMENT -call-seq: - commercial() -> Date <br /> - -If no arguments are given: - - COMMENT - - parser = util_parser - method_obj = RDoc::AnyMethod.new nil, 'blah' - - parser.find_modifiers comment, method_obj - - expected = <<-CALL_SEQ.chomp -commercial() -> Date <br /> - - CALL_SEQ - - assert_equal expected, method_obj.call_seq - end - - def test_find_modifiers_nodoc - comment = RDoc::Comment.new <<-COMMENT -/* :nodoc: - * - * Blah - */ - - COMMENT - - parser = util_parser - method_obj = RDoc::AnyMethod.new nil, 'blah' - - parser.find_modifiers comment, method_obj - - assert_nil method_obj.document_self - end - - def test_find_modifiers_yields - comment = RDoc::Comment.new <<-COMMENT, @top_level, :c -/* :yields: a, b - * - * Blah - */ - - COMMENT - - parser = util_parser - method_obj = RDoc::AnyMethod.new nil, 'blah' - - parser.find_modifiers comment, method_obj - - assert_equal 'a, b', method_obj.block_params - - assert_equal "\n\nBlah", comment.text - end - - def test_handle_method_args_minus_1 - parser = util_parser "Document-method: Object#m\n blah */" - - parser.content = <<-BODY -VALUE -rb_other(VALUE obj) { - rb_funcall(obj, rb_intern("other"), 0); - return rb_str_new2("blah, blah, blah"); -} - -VALUE -rb_m(int argc, VALUE *argv, VALUE obj) { - VALUE o1, o2; - rb_scan_args(argc, argv, "1", &o1, &o2); -} - BODY - - parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', -1 - - m = @top_level.find_module_named('Object').method_list.first - - assert_equal 'm', m.name - assert_equal @top_level, m.file - assert_equal 7, m.line - - assert_equal '(p1)', m.params - end - - def test_handle_method_args_0 - parser = util_parser "Document-method: BasicObject#==\n blah */" - - parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', 0 - - bo = @top_level.find_module_named 'BasicObject' - - assert_equal 1, bo.method_list.length - - equals2 = bo.method_list.first - - assert_equal '()', equals2.params - end - - def test_handle_method_args_1 - parser = util_parser "Document-method: BasicObject#==\n blah */" - - parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', 1 - - bo = @top_level.find_module_named 'BasicObject' - - assert_equal 1, bo.method_list.length - - equals2 = bo.method_list.first - - assert_equal '(p1)', equals2.params - end - - def test_handle_method_args_2 - parser = util_parser "Document-method: BasicObject#==\n blah */" - - parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', 2 - - bo = @top_level.find_module_named 'BasicObject' - - assert_equal 1, bo.method_list.length - - equals2 = bo.method_list.first - - assert_equal '(p1, p2)', equals2.params - end - - # test_handle_args_minus_1 handled by test_handle_method - - def test_handle_method_args_minus_2 - parser = util_parser "Document-method: BasicObject#==\n blah */" - - parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', -2 - - bo = @top_level.find_module_named 'BasicObject' - - assert_equal 1, bo.method_list.length - - equals2 = bo.method_list.first - - assert_equal '(*args)', equals2.params - end - - def test_handle_method_initialize - parser = util_parser "Document-method: BasicObject::new\n blah */" - - parser.handle_method('private_method', 'rb_cBasicObject', - 'initialize', 'rb_obj_dummy', -1) - - bo = @top_level.find_module_named 'BasicObject' - - assert_equal 1, bo.method_list.length - - new = bo.method_list.first - - assert_equal 'new', new.name - assert_equal :public, new.visibility - end - - def test_handle_singleton - parser = util_parser <<-SINGLE -void Init_Blah(void) { - cDate = rb_define_class("Date", rb_cObject); - sDate = rb_singleton_class(cDate); -} - SINGLE - - parser.scan - - assert_equal 'Date', parser.known_classes['sDate'] - assert_equal 'Date', parser.singleton_classes['sDate'] - end - - def test_look_for_directives_in - parser = util_parser - - comment = RDoc::Comment.new "# :other: not_handled\n" - - parser.look_for_directives_in @top_level, comment - - assert_equal "# :other: not_handled\n", comment.text - assert_equal 'not_handled', @top_level.metadata['other'] - end - - def test_load_variable_map - some_ext = @top_level.add_class RDoc::NormalClass, 'SomeExt' - @top_level.add_class RDoc::NormalClass, 'OtherExt' - - @store.cache[:c_class_variables][@fn] = { 'cSomeExt' => 'SomeExt' } - @store.cache[:c_class_variables]['other.c'] = { 'cOtherExt' => 'OtherExt' } - - parser = util_parser - - map = parser.load_variable_map :c_class_variables - - expected = { 'cSomeExt' => some_ext } - - assert_equal expected, map - - assert_equal 'SomeExt', parser.known_classes['cSomeExt'] - assert_nil parser.known_classes['cOtherExt'] - end - - def test_load_variable_map_empty - parser = util_parser - - map = parser.load_variable_map :c_class_variables - - assert_empty map - end - - def test_load_variable_map_legacy - @store.cache[:c_class_variables] = nil - - parser = util_parser - - map = parser.load_variable_map :c_class_variables - - assert_empty map - end - - def test_load_variable_map_singleton - @top_level.add_class RDoc::NormalClass, 'SomeExt' - @top_level.add_class RDoc::NormalClass, 'OtherExt' - - @store.cache[:c_singleton_class_variables][@fn] = - { 'cSomeExt' => 'SomeExt' } - @store.cache[:c_singleton_class_variables]['other.c'] = - { 'cOtherExt' => 'OtherExt' } - - parser = util_parser - - map = parser.load_variable_map :c_singleton_class_variables - - expected = { 'cSomeExt' => 'SomeExt' } - - assert_equal expected, map - - assert_equal 'SomeExt', parser.known_classes['cSomeExt'] - assert_nil parser.known_classes['cOtherExt'] - end - - def test_load_variable_map_trim - a = @top_level.add_class RDoc::NormalClass, 'A' - - @store.cache[:c_class_variables][@fn] = { - 'cA' => 'A', - 'cB' => 'B', - } - - parser = util_parser - - map = parser.load_variable_map :c_class_variables - - expected = { 'cA' => a } - - assert_equal expected, map - end - - def test_define_method - content = <<-EOF -/*Method Comment! */ -static VALUE -rb_io_s_read(argc, argv, io) - int argc; - VALUE *argv; - VALUE io; -{ -} - -void -Init_IO(void) { - /* - * a comment for class Foo on rb_define_class - */ - VALUE rb_cIO = rb_define_class("IO", rb_cObject); - rb_define_singleton_method(rb_cIO, "read", rb_io_s_read, -1); -} - EOF - - klass = util_get_class content, 'rb_cIO' - read_method = klass.method_list.first - assert_equal "read", read_method.name - assert_equal "Method Comment! ", read_method.comment.text - assert_equal "rb_io_s_read", read_method.c_function - assert read_method.singleton - assert_nil read_method.section.title - end - - def test_define_method_with_category - content = <<-EOF -/* :category: Awesome Methods - Method Comment! - */ -static VALUE -rb_io_s_read(argc, argv, io) - int argc; - VALUE *argv; - VALUE io; -{ -} - -void -Init_IO(void) { - /* - * a comment for class Foo on rb_define_class - */ - VALUE rb_cIO = rb_define_class("IO", rb_cObject); - rb_define_singleton_method(rb_cIO, "read", rb_io_s_read, -1); -} - EOF - - klass = util_get_class content, 'rb_cIO' - read_method = klass.method_list.first - assert_equal "read", read_method.name - assert_equal "Method Comment!", read_method.comment.text.strip - assert_equal "rb_io_s_read", read_method.c_function - assert read_method.singleton - assert_equal "Awesome Methods", read_method.section.title - end - - def test_define_method_dynamically - content = <<-EOF -void -Init_foo(void) -{ - rb_define_singleton_method(obj, "foo", foo, -1); -} - EOF - - klass = util_get_class content, 'obj' - assert_nil klass - end - - def test_define_method_with_prototype - content = <<-EOF -static VALUE rb_io_s_read(int, VALUE*, VALUE); - -/* Method Comment! */ -static VALUE -rb_io_s_read(argc, argv, io) - int argc; - VALUE *argv; - VALUE io; -{ -} - -void -Init_IO(void) { - /* - * a comment for class Foo on rb_define_class - */ - VALUE rb_cIO = rb_define_class("IO", rb_cObject); - rb_define_singleton_method(rb_cIO, "read", rb_io_s_read, -1); -} - EOF - - klass = util_get_class content, 'rb_cIO' - read_method = klass.method_list.first - assert_equal "read", read_method.name - assert_equal "Method Comment! ", read_method.comment.text - assert_equal "rb_io_s_read", read_method.c_function - assert read_method.singleton - end - - def test_define_method_private - content = <<-EOF -/*Method Comment! */ -static VALUE -rb_io_s_read(argc, argv, io) - int argc; - VALUE *argv; - VALUE io; -{ -} - -void -Init_IO(void) { - /* - * a comment for class Foo on rb_define_class - */ - VALUE rb_cIO = rb_define_class("IO", rb_cObject); - rb_define_private_method(rb_cIO, "read", rb_io_s_read, -1); -} - EOF - - klass = util_get_class content, 'rb_cIO' - read_method = klass.method_list.first - assert_equal 'IO#read', read_method.full_name - assert_equal :private, read_method.visibility - assert_equal "Method Comment! ", read_method.comment.text - end - - def test_define_method_private_singleton - content = <<-EOF -/*Method Comment! */ -static VALUE -rb_io_s_read(argc, argv, io) - int argc; - VALUE *argv; - VALUE io; -{ -} - -void -Init_IO(void) { - /* - * a comment for class Foo on rb_define_class - */ - VALUE rb_cIO = rb_define_class("IO", rb_cObject); - VALUE rb_cIO_s = rb_singleton_class(rb_cIO); - rb_define_private_method(rb_cIO_s, "read", rb_io_s_read, -1); -} - EOF - - klass = util_get_class content, 'rb_cIO' - read_method = klass.method_list.first - assert_equal "read", read_method.name - assert_equal "Method Comment! ", read_method.comment.text - assert_equal :private, read_method.visibility - assert read_method.singleton - end - - def test_define_method_singleton - content = <<-EOF -/*Method Comment! */ -static VALUE -rb_io_s_read(argc, argv, io) - int argc; - VALUE *argv; - VALUE io; -{ -} - -void -Init_IO(void) { - /* - * a comment for class Foo on rb_define_class - */ - VALUE rb_cIO = rb_define_class("IO", rb_cObject); - VALUE rb_cIO_s = rb_singleton_class(rb_cIO); - rb_define_method(rb_cIO_s, "read", rb_io_s_read, -1); -} - EOF - - klass = util_get_class content, 'rb_cIO' - read_method = klass.method_list.first - assert_equal "read", read_method.name - assert_equal "Method Comment! ", read_method.comment.text - assert read_method.singleton - end - - def test_rb_scan_args - parser = util_parser - - assert_equal '(p1)', - parser.rb_scan_args('rb_scan_args(a, b, "1",)') - assert_equal '(p1, p2)', - parser.rb_scan_args('rb_scan_args(a, b, "2",)') - - assert_equal '(p1 = v1)', - parser.rb_scan_args('rb_scan_args(a, b, "01",)') - assert_equal '(p1 = v1, p2 = v2)', - parser.rb_scan_args('rb_scan_args(a, b, "02",)') - - assert_equal '(p1, p2 = v2)', - parser.rb_scan_args('rb_scan_args(a, b, "11",)') - - assert_equal '(p1, *args)', - parser.rb_scan_args('rb_scan_args(a, b, "1*",)') - assert_equal '(p1, p2 = {})', - parser.rb_scan_args('rb_scan_args(a, b, "1:",)') - assert_equal '(p1, &block)', - parser.rb_scan_args('rb_scan_args(a, b, "1&",)') - - assert_equal '(p1, p2)', - parser.rb_scan_args('rb_scan_args(a, b, "101",)') - - assert_equal '(p1, p2 = v2, p3)', - parser.rb_scan_args('rb_scan_args(a, b, "111",)') - - assert_equal '(p1, *args, p3)', - parser.rb_scan_args('rb_scan_args(a, b, "1*1",)') - - assert_equal '(p1, p2 = v2, *args)', - parser.rb_scan_args('rb_scan_args(a, b, "11*",)') - assert_equal '(p1, p2 = v2, p3 = {})', - parser.rb_scan_args('rb_scan_args(a, b, "11:",)') - assert_equal '(p1, p2 = v2, &block)', - parser.rb_scan_args('rb_scan_args(a, b, "11&",)') - - assert_equal '(p1, p2 = v2, *args, p4, p5 = {}, &block)', - parser.rb_scan_args('rb_scan_args(a, b, "11*1:&",)') - - # The following aren't valid according to spec but are according to the - # implementation. - assert_equal '(*args)', - parser.rb_scan_args('rb_scan_args(a, b, "*",)') - assert_equal '(p1 = {})', - parser.rb_scan_args('rb_scan_args(a, b, ":",)') - assert_equal '(&block)', - parser.rb_scan_args('rb_scan_args(a, b, "&",)') - - assert_equal '(*args, p2 = {})', - parser.rb_scan_args('rb_scan_args(a, b, "*:",)') - assert_equal '(p1 = {}, &block)', - parser.rb_scan_args('rb_scan_args(a, b, ":&",)') - assert_equal '(*args, p2 = {}, &block)', - parser.rb_scan_args('rb_scan_args(a, b, "*:&",)') - end - - def test_scan - parser = util_parser <<-C -void Init(void) { - mM = rb_define_module("M"); - cC = rb_define_class("C", rb_cObject); - sC = rb_singleton_class(cC); -} - C - - parser.scan - - expected = { - @fn => { - 'mM' => 'M', - 'cC' => 'C', }} - assert_equal expected, @store.c_class_variables - - expected = { - @fn => { - 'sC' => 'C' } } - assert_equal expected, @store.c_singleton_class_variables - end - - def test_scan_method_copy - parser = util_parser <<-C -/* - * call-seq: - * pathname.to_s -> string - * pathname.to_path -> string - * - * Return the path as a String. - * - * to_path is implemented so Pathname objects are usable with File.open, etc. - */ -static VALUE -path_to_s(VALUE self) { } - -/* - * call-seq: - * str[index] -> new_str or nil - * str[start, length] -> new_str or nil - * str.slice(index) -> new_str or nil - * str.slice(start, length) -> new_str or nil - */ -static VALUE -path_aref_m(int argc, VALUE *argv, VALUE str) { } - -/* - * call-seq: - * string <=> other_string -> -1, 0, +1 or nil - */ -static VALUE -path_cmp_m(VALUE str1, VALUE str2) { } - -/* - * call-seq: - * str == obj -> true or false - * str === obj -> true or false - */ -VALUE -rb_str_equal(VALUE str1, VALUE str2) { } - -Init_pathname() -{ - rb_cPathname = rb_define_class("Pathname", rb_cObject); - - rb_define_method(rb_cPathname, "to_s", path_to_s, 0); - rb_define_method(rb_cPathname, "to_path", path_to_s, 0); - rb_define_method(rb_cPathname, "[]", path_aref_m, -1); - rb_define_method(rb_cPathname, "slice", path_aref_m, -1); - rb_define_method(rb_cPathname, "<=>", path_cmp_m, 1); - rb_define_method(rb_cPathname, "==", rb_str_equal), 2); - rb_define_method(rb_cPathname, "===", rb_str_equal), 2); -} - C - - parser.scan - - pathname = @store.classes_hash['Pathname'] - - to_path = pathname.method_list.find { |m| m.name == 'to_path' } - assert_equal "pathname.to_path -> string", to_path.call_seq - - to_s = pathname.method_list.find { |m| m.name == 'to_s' } - assert_equal "pathname.to_s -> string", to_s.call_seq - - index_expected = <<-EXPECTED.chomp -str[index] -> new_str or nil -str[start, length] -> new_str or nil - EXPECTED - - index = pathname.method_list.find { |m| m.name == '[]' } - assert_equal index_expected, index.call_seq, '[]' - - slice_expected = <<-EXPECTED.chomp -str.slice(index) -> new_str or nil -str.slice(start, length) -> new_str or nil - EXPECTED - - slice = pathname.method_list.find { |m| m.name == 'slice' } - assert_equal slice_expected, slice.call_seq - - spaceship = pathname.method_list.find { |m| m.name == '<=>' } - assert_equal "string <=> other_string -> -1, 0, +1 or nil", - spaceship.call_seq - - equals2 = pathname.method_list.find { |m| m.name == '==' } - assert_match 'str == obj', equals2.call_seq - - equals3 = pathname.method_list.find { |m| m.name == '===' } - assert_match 'str === obj', equals3.call_seq - end - - def test_scan_order_dependent - parser = util_parser <<-C -void a(void) { - mA = rb_define_module("A"); -} - -void b(void) { - cB = rb_define_class_under(mA, "B", rb_cObject); -} - -void c(void) { - mC = rb_define_module_under(cB, "C"); -} - -void d(void) { - mD = rb_define_class_under(mC, "D"); -} - C - - parser.scan - - assert_equal %w[A A::B A::B::C], - @store.all_classes_and_modules.map { |m| m.full_name }.sort - end - - def test_markup_format_default - content = <<-EOF -void Init_Blah(void) { - cBlah = rb_define_class("Blah", rb_cObject); - - /* - * This should be interpreted in the default format. - */ - rb_attr(cBlah, rb_intern("default_format"), 1, 1, Qfalse); -} - EOF - - klass = util_get_class content, 'cBlah' - assert_equal("rdoc", klass.attributes.find {|a| a.name == "default_format"}.comment.format) - end - - def test_markup_format_override - content = <<-EOF -void Init_Blah(void) { - cBlah = rb_define_class("Blah", rb_cObject); - - /* - * This should be interpreted in the default format. - */ - rb_attr(cBlah, rb_intern("default_format"), 1, 1, Qfalse); -} - EOF - - @options.markup = "markdown" - klass = util_get_class content, 'cBlah' - assert_equal("markdown", klass.attributes.find {|a| a.name == "default_format"}.comment.format) - end - - def util_get_class content, name = nil - @parser = util_parser content - @parser.scan - - @parser.classes[name] if name - end - - def util_parser content = '' - RDoc::Parser::C.new @top_level, @fn, content, @options, @stats - end - -end diff --git a/test/rdoc/test_rdoc_parser_changelog.rb b/test/rdoc/test_rdoc_parser_changelog.rb deleted file mode 100644 index 587a156d3a..0000000000 --- a/test/rdoc/test_rdoc_parser_changelog.rb +++ /dev/null @@ -1,484 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocParserChangeLog < RDoc::TestCase - - def setup - super - - @tempfile = Tempfile.new 'ChangeLog' - @top_level = @store.add_file @tempfile.path - @options = RDoc::Options.new - @stats = RDoc::Stats.new @store, 0 - end - - def teardown - @tempfile.close! - - super - end - - def test_class_can_parse - parser = RDoc::Parser::ChangeLog - - temp_dir do - FileUtils.touch 'ChangeLog' - assert_equal parser, parser.can_parse('ChangeLog') - - assert_equal parser, parser.can_parse(@tempfile.path) - - FileUtils.touch 'ChangeLog.rb' - assert_equal RDoc::Parser::Ruby, parser.can_parse('ChangeLog.rb') - end - end - - def test_continue_entry_body - parser = util_parser - - entry_body = ['a'.dup] - - parser.continue_entry_body entry_body, 'b' - - assert_equal ['a b'], entry_body - end - - def test_continue_entry_body_empty - parser = util_parser - - entry_body = [] - - parser.continue_entry_body entry_body, '' - - assert_empty entry_body - end - - def test_continue_entry_body_function - parser = util_parser - - entry_body = ['file: (func1)'.dup] - - parser.continue_entry_body entry_body, '(func2): blah' - - assert_equal ['file: (func1, func2): blah'], entry_body - end - - def test_create_document - parser = util_parser - - groups = { - '2012-12-04' => [ - ['Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>', - %w[a:one b:two]], - ['Tue Dec 4 08:32:10 2012 Eric Hodel <drbrain@segment7.net>', - %w[c:three d:four]]], - '2012-12-03' => [ - ['Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>', - %w[e:five f:six]]], - } - - expected = - doc( - head(1, File.basename(@tempfile.path)), - blank_line, - head(2, '2012-12-04'), - blank_line, - head(3, 'Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>'), - blank_line, - list(:NOTE, item('a', para('one')), item('b', para('two'))), - head(3, 'Tue Dec 4 08:32:10 2012 Eric Hodel <drbrain@segment7.net>'), - blank_line, - list(:NOTE, item('c', para('three')), item('d', para('four'))), - head(2, '2012-12-03'), - blank_line, - head(3, 'Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>'), - blank_line, - list(:NOTE, item('e', para('five')), item('f', para('six')))) - - expected.file = @top_level - - document = parser.create_document(groups) - - assert_equal expected, document - - assert_equal 2, document.omit_headings_below - - headings = document.parts.select do |part| - RDoc::Markup::Heading === part and part.level == 2 - end - - refute headings.all? { |heading| heading.text.frozen? } - end - - def test_create_entries - parser = util_parser - - entries = [ - ['Tue Dec 1 02:03:04 2012 Eric Hodel <drbrain@segment7.net>', - %w[a:one b:two]], - ['Tue Dec 5 06:07:08 2012 Eric Hodel <drbrain@segment7.net>', - %w[c:three d:four]], - ] - - expected = [ - head(3, 'Tue Dec 1 02:03:04 2012 Eric Hodel <drbrain@segment7.net>'), - blank_line, - list(:NOTE, item('a', para('one')), item('b', para('two'))), - head(3, 'Tue Dec 5 06:07:08 2012 Eric Hodel <drbrain@segment7.net>'), - blank_line, - list(:NOTE, item('c', para('three')), item('d', para('four'))), - ] - - entries = parser.create_entries(entries) - assert_equal expected, entries - end - - def test_create_entries_colons - parser = util_parser - - entries = [ - ['Wed Dec 5 12:17:11 2012 Naohisa Goto <ngotogenome@gmail.com>', - ['func.rb (DL::Function#bind): log stuff [ruby-core:50562]']], - ] - - expected = [ - head(3, - 'Wed Dec 5 12:17:11 2012 Naohisa Goto <ngotogenome@gmail.com>'), - blank_line, - list(:NOTE, - item('func.rb (DL::Function#bind)', - para('log stuff [ruby-core:50562]')))] - - assert_equal expected, parser.create_entries(entries) - end - - def test_create_items - parser = util_parser - - items = [ - 'README.EXT: Converted to RDoc format', - 'README.EXT.ja: ditto', - ] - - expected = - list(:NOTE, - item('README.EXT', - para('Converted to RDoc format')), - item('README.EXT.ja', - para('ditto'))) - - assert_equal expected, parser.create_items(items) - end - - def test_group_entries - parser = util_parser - - entries = [ - [ 'Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>', - %w[one two]], - [ 'Tue Dec 4 08:32:10 2012 Eric Hodel <drbrain@segment7.net>', - %w[three four]], - [ 'Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>', - %w[five six]], - [ '2008-01-30 H.J. Lu <hongjiu.lu@intel.com>', - %w[seven eight]]] - - expected = { - '2012-12-04' => [ - ['Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>', - %w[one two]], - ['Tue Dec 4 08:32:10 2012 Eric Hodel <drbrain@segment7.net>', - %w[three four]]], - '2012-12-03' => [ - ['Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>', - %w[five six]]], - '2008-01-30' => [ - ['2008-01-30 H.J. Lu <hongjiu.lu@intel.com>', - %w[seven eight]]], - } - - assert_equal expected, parser.group_entries(entries) - end - - def test_parse_entries - parser = util_parser <<-ChangeLog -Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net> - - * README.EXT: Converted to RDoc format - * README.EXT.ja: ditto - -Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net> - - * compile.c (iseq_specialized_instruction): - change condition of using `opt_send_simple'. - More method invocations can be simple. - -commit\ 8187228de0142d3ac7950b7d977c2849e934c637 - -Other note that will be ignored - - ChangeLog - - expected = [ - [ 'Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>', - [ 'README.EXT: Converted to RDoc format', - 'README.EXT.ja: ditto']], - [ 'Mon Dec 3 20:28:02 2012 Koichi Sasada <ko1@atdot.net>', - [ 'compile.c (iseq_specialized_instruction): change condition of ' + - 'using `opt_send_simple\'. More method invocations can be simple.']]] - - assert_equal expected, parser.parse_entries - end - - def test_parse_entries_bad_time - parser = util_parser <<-ChangeLog -2008-01-30 H.J. Lu <hongjiu.lu@intel.com> - - PR libffi/34612 - * src/x86/sysv.S (ffi_closure_SYSV): Pop 4 byte from stack when - returning struct. - - ChangeLog - - expected = [ - [ '2008-01-30 H.J. Lu <hongjiu.lu@intel.com>', - [ 'src/x86/sysv.S (ffi_closure_SYSV): Pop 4 byte from stack when ' + - 'returning struct.']] - ] - - assert_equal expected, parser.parse_entries - end - - def test_parse_entries_gnu - parser = util_parser <<-ChangeLog -1998-08-17 Richard Stallman <rms@gnu.org> - -* register.el (insert-register): Return nil. -(jump-to-register): Likewise. - -* sort.el (sort-subr): Return nil. - -* keyboard.c (menu_bar_items, tool_bar_items) -(Fexecute_extended_command): Deal with 'keymap' property. - ChangeLog - - expected = [ - [ '1998-08-17 Richard Stallman <rms@gnu.org>', - [ 'register.el (insert-register): Return nil.', - '(jump-to-register): Likewise.', - 'sort.el (sort-subr): Return nil.', - 'keyboard.c (menu_bar_items, tool_bar_items, ' + - 'Fexecute_extended_command): Deal with \'keymap\' property.']]] - - assert_equal expected, parser.parse_entries - end - - def test_parse_entries_git - parser = util_parser <<-ChangeLog -commit\ 709bed2afaee50e2ce803f87bf1ee8291bea41e3 - Author: git <svn-admin@ruby-lang.org> - Date: 2021-01-21 01:03:52 +0900 - - * 2021-01-21 [ci skip] -ChangeLog - - expected = [ - [ "709bed2afaee50e2ce80", - [ "git", "svn-admin@ruby-lang.org", - "2021-01-21 01:03:52 +0900", - "* 2021-01-21 [ci skip]\n"]]] - - assert_equal expected, parser.parse_entries - end - - def test_scan - parser = util_parser <<-ChangeLog -Tue Dec 4 08:32:10 2012 Eric Hodel <drbrain@segment7.net> - - * lib/rdoc/ri/driver.rb: Fixed ri page display for files with - extensions. - * test/rdoc/test_rdoc_ri_driver.rb: Test for above - -Mon Dec 3 20:37:22 2012 Koichi Sasada <ko1@atdot.net> - - * vm_exec.c: check VM_COLLECT_USAGE_DETAILS. - - ChangeLog - - parser.scan - - expected = doc( - head(1, File.basename(@tempfile.path)), - blank_line, - head(2, '2012-12-04'), - blank_line, - head(3, 'Tue Dec 4 08:32:10 2012 Eric Hodel <drbrain@segment7.net>'), - blank_line, - list(:NOTE, - item('lib/rdoc/ri/driver.rb', para('Fixed ri page display for ' + - 'files with extensions.')), - item('test/rdoc/test_rdoc_ri_driver.rb', para('Test for above'))), - head(2, '2012-12-03'), - blank_line, - head(3, 'Mon Dec 3 20:37:22 2012 Koichi Sasada <ko1@atdot.net>'), - blank_line, - list(:NOTE, - item('vm_exec.c', para('check VM_COLLECT_USAGE_DETAILS.')))) - - expected.file = @top_level - - assert_equal expected, @top_level.comment - end - - def test_scan_git - parser = util_parser <<-ChangeLog -commit\ 38816887962ec167ee46acf500f68df5c3013163 -Author: git <svn-admin@ruby-lang.org> -Date: Sun Jan 24 14:35:51 2021 +0900 - - * 2021-01-24 [ci skip] - -commit\ db7d0b89f6eca66cc7eb155c95f9123133da1ffc -Author: git <svn-admin@ruby-lang.org> -Date: Sat, 23 Jan 2021 06:01:39 +0900 - - * 2021-01-23 [ci skip] - -commit\ a3efbda7128ef20b55505b32d1608ea48f80af4a -Author: git <svn-admin@ruby-lang.org> -Date: 2021-01-22T02:49:39+09:00 - - * 2021-01-22 [ci skip] - -commit\ 709bed2afaee50e2ce803f87bf1ee8291bea41e3 - Author: git <svn-admin@ruby-lang.org> - Date: 2021-01-21 01:03:52 +0900 - - * 2021-01-21 [ci skip] - -commit\ a8dc5156e183489c5121fb1759bda5d9406d9175 - Author: git <svn-admin@ruby-lang.org> - Date: 2021-01-20 01:58:26 +0900 - - * 2021-01-20 [ci skip] - -commit\ de5f8a92d5001799bedb3b1a271a2d9b23c6c8fb - Author: Masataka Pocke Kuwabara <kuwabara@pocke.me> - Date: 2021-01-01 14:25:08 +0900 - - Make args info for RubyVM::AST to available on endless method without parens - - Problem - === - - Arguments information is missing for endless method without parens. - For example: - - ```ruby - # ok - ``` - - It causes an error if a program expects `args` node exists. - - Solution - === - - Call `new_args` on this case. -ChangeLog - - parser.scan - - expected = doc( - head(1, File.basename(@tempfile.path)), - blank_line, - head(2, '2021-01-24'), - blank_line, - log_entry(nil, '38816887962ec167ee46', - 'git', 'svn-admin@ruby-lang.org', 'Sun Jan 24 14:35:51 2021 +0900', - [list(:BULLET, item(nil, para('2021-01-24 [ci skip]')))]), - head(2, '2021-01-23'), - blank_line, - log_entry(nil, 'db7d0b89f6eca66cc7eb', - 'git', 'svn-admin@ruby-lang.org', 'Sat, 23 Jan 2021 06:01:39 +0900', - [list(:BULLET, item(nil, para('2021-01-23 [ci skip]')))]), - head(2, '2021-01-22'), - blank_line, - log_entry(nil, 'a3efbda7128ef20b5550', - 'git', 'svn-admin@ruby-lang.org', '2021-01-22T02:49:39+09:00', - [list(:BULLET, item(nil, para('2021-01-22 [ci skip]')))]), - head(2, '2021-01-21'), - blank_line, - log_entry(nil, '709bed2afaee50e2ce80', - 'git', 'svn-admin@ruby-lang.org', '2021-01-21 01:03:52 +0900', - [list(:BULLET, item(nil, para('2021-01-21 [ci skip]')))]), - head(2, '2021-01-20'), - blank_line, - log_entry(nil, 'a8dc5156e183489c5121', - 'git', 'svn-admin@ruby-lang.org', '2021-01-20 01:58:26 +0900', - [list(:BULLET, item(nil, para('2021-01-20 [ci skip]')))]), - head(2, '2021-01-01'), - blank_line, - log_entry(nil, 'de5f8a92d5001799bedb', - 'Masataka Pocke Kuwabara', 'kuwabara@pocke.me', '2021-01-01 14:25:08 +0900', - [head(4, 'Make args info for RubyVM::AST to available on endless method without parens'), - head(5, 'Problem'), - para("Arguments information is missing for endless method without parens.\n" + - "For example:"), - verb("# ok\n").tap {|v| v.format = :ruby}, - para('It causes an error if a program expects <code>args</code> node exists.'), - head(5, 'Solution'), - para('Call <code>new_args</code> on this case.')])) - - expected.file = @top_level - - assert_equal expected, @top_level.comment - end - - def test_scan_git_commit_date - parser = util_parser <<-ChangeLog -commit\ ee1e690a2df901adb279d7a63fbd92c64e0a5ae6 - Author: Igor Zubkov <igor.zubkov@gmail.com> - AuthorDate: 2016-10-25 03:56:11 +0900 - Commit: Nobuyoshi Nakada <nobu@ruby-lang.org> - CommitDate: 2021-01-07 13:40:42 +0900 - - We don't need "require 'uri'" after "require 'net/http'". - -commit\ 4d0985a7bd8f591dff4b430e288bfd83af782e51 - Author: git <svn-admin@ruby-lang.org> - AuthorDate: 2021-01-07 10:21:34 +0900 - Commit: git <svn-admin@ruby-lang.org> - CommitDate: 2021-01-07 10:21:34 +0900 - - * 2021-01-07 [ci skip] -ChangeLog - - parser.scan - - expected = doc( - head(1, File.basename(@tempfile.path)), - blank_line, - head(2, "2021-01-07"), - blank_line, - log_entry(nil, 'ee1e690a2df901adb279', - 'Igor Zubkov', 'igor.zubkov@gmail.com', - '2016-10-25 03:56:11 +0900', - [head(4, %[We don't need "require 'uri'" after "require 'net/http'".])]), - log_entry(nil, '4d0985a7bd8f591dff4b', - 'git', 'svn-admin@ruby-lang.org', - '2021-01-07 10:21:34 +0900', - [list(:BULLET, item(nil, para("2021-01-07 [ci skip]")))])) - - expected.file = @top_level - - assert_equal expected, @top_level.comment - end - - def util_parser content = '' - RDoc::Parser::ChangeLog.new \ - @top_level, @tempfile.path, content, @options, @stats - end - - def log_entry(*a) - RDoc::Parser::ChangeLog::Git::LogEntry.new(*a) - end -end diff --git a/test/rdoc/test_rdoc_parser_markdown.rb b/test/rdoc/test_rdoc_parser_markdown.rb deleted file mode 100644 index cca9c1ddfd..0000000000 --- a/test/rdoc/test_rdoc_parser_markdown.rb +++ /dev/null @@ -1,61 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocParserMarkdown < RDoc::TestCase - - def setup - super - - @RP = RDoc::Parser - - @tempfile = Tempfile.new self.class.name - filename = @tempfile.path - - @top_level = @store.add_file filename - @fn = filename - @options = RDoc::Options.new - @stats = RDoc::Stats.new @store, 0 - end - - def teardown - super - - @tempfile.close! - end - - def test_file - assert_kind_of RDoc::Parser::Text, util_parser('') - end - - def test_class_can_parse - temp_dir do - FileUtils.touch 'foo.md' - assert_equal @RP::Markdown, @RP.can_parse('foo.md') - FileUtils.touch 'foo.md.ja' - assert_equal @RP::Markdown, @RP.can_parse('foo.md.ja') - - FileUtils.touch 'foo.markdown' - assert_equal @RP::Markdown, @RP.can_parse('foo.markdown') - FileUtils.touch 'foo.markdown.ja' - assert_equal @RP::Markdown, @RP.can_parse('foo.markdown.ja') - end - end - - def test_scan - parser = util_parser 'it *really* works' - - expected = - @RM::Document.new( - @RM::Paragraph.new('it _really_ works')) - expected.file = @top_level - - parser.scan - - assert_equal expected, @top_level.comment.parse - end - - def util_parser content - RDoc::Parser::Markdown.new @top_level, @fn, content, @options, @stats - end - -end diff --git a/test/rdoc/test_rdoc_parser_prism_ruby.rb b/test/rdoc/test_rdoc_parser_prism_ruby.rb deleted file mode 100644 index 16b8d522b6..0000000000 --- a/test/rdoc/test_rdoc_parser_prism_ruby.rb +++ /dev/null @@ -1,2016 +0,0 @@ -# frozen_string_literal: true - -require_relative 'helper' -require 'rdoc/parser' -require 'rdoc/parser/prism_ruby' - -module RDocParserPrismTestCases - def setup - super - - @tempfile = Tempfile.new self.class.name - @filename = @tempfile.path - - @top_level = @store.add_file @filename - - @options = RDoc::Options.new - @options.quiet = true - @options.option_parser = OptionParser.new - - @comment = RDoc::Comment.new '', @top_level - - @stats = RDoc::Stats.new @store, 0 - end - - def teardown - super - - @tempfile.close! - end - - def test_look_for_directives_in_section - util_parser <<~RUBY - # :section: new section - RUBY - section = @top_level.current_section - assert_equal 'new section', section.title - end - - def test_look_for_directives_in_commented - util_parser <<~RUBY - # how to make a section: - # # :section: new section - RUBY - section = @top_level.current_section - assert_nil section.title - end - - def test_look_for_directives_in_unhandled - util_parser <<~RUBY - # :unhandled: blah - RUBY - assert_equal 'blah', @top_level.metadata['unhandled'] - end - - def test_block_comment - util_parser <<~RUBY - =begin rdoc - foo - =end - class A - =begin - bar - baz - =end - def f; end - end - RUBY - klass = @top_level.classes.first - meth = klass.method_list.first - assert_equal 'foo', klass.comment.text.strip - assert_equal "bar\nbaz", meth.comment.text.strip - end - - def test_module - util_parser <<~RUBY - # my module - module Foo - end - RUBY - mod = @top_level.modules.first - assert_equal 'Foo', mod.full_name - assert_equal 'my module', mod.comment.text - assert_equal [@top_level], mod.in_files - end - - def test_nested_module_with_colon - util_parser <<~RUBY - module Foo - module Bar; end - module Bar::Baz1; end - module ::Foo - module Bar2; end - end - end - module ::Baz; end - module Foo::Bar::Baz2 - module ::Foo2 - module Bar; end - end - module Blah; end - end - RUBY - module_names = @store.all_modules.map(&:full_name) - expected = %w[ - Foo Foo::Bar Foo::Bar::Baz1 Foo::Bar2 Baz Foo::Bar::Baz2 Foo2 Foo2::Bar Foo::Bar::Baz2::Blah - ] - assert_equal expected.sort, module_names.sort - end - - def test_class - util_parser <<~RUBY - # my class - class Foo - end - RUBY - klass = @top_level.classes.first - assert_equal 'Foo', klass.full_name - assert_equal 'my class', klass.comment.text - assert_equal [@top_level], klass.in_files - assert_equal 2, klass.line - end - - def test_nested_class_with_colon - util_parser <<~RUBY - class Foo - class Bar; end - class Bar::Baz1; end - class ::Foo - class Bar2; end - end - end - class ::Baz; end - class Foo::Bar::Baz2 - class ::Foo2 - class Bar; end - end - class Blah; end - end - RUBY - class_names = @store.all_classes.map(&:full_name) - expected = %w[ - Foo Foo::Bar Foo::Bar::Baz1 Foo::Bar2 Baz Foo::Bar::Baz2 Foo2 Foo2::Bar Foo::Bar::Baz2::Blah - ] - assert_equal expected.sort, class_names.sort - end - - def test_open_class_with_superclass - util_parser <<~RUBY - class A; end - - class B < A - def m1; end - end - - class B < A - def m2; end - end - - class C < String - def m1; end - end - - class C < String - def m2; end - end - RUBY - classes = @top_level.classes - assert_equal 3, classes.size - _a, b, c = classes - assert_equal 'A', b.superclass.full_name - assert_equal 'String', c.superclass - assert_equal ['m1', 'm2'], b.method_list.map(&:name) - assert_equal ['m1', 'm2'], c.method_list.map(&:name) - end - - def test_confusing_superclass - util_parser <<~RUBY - module A - class B; end - end - - module A - class C1 < A::B; end - end - - class A::C2 < A::B; end - - module A::A - class B; end - end - - module A - class C3 < A::B; end - end - - class A::C4 < A::B; end - RUBY - mod = @top_level.modules.first - classes = mod.classes - assert_equal ['A::B', 'A::C1', 'A::C2', 'A::C3', 'A::C4'], classes.map(&:full_name) - assert_equal ['A::B', 'A::B', 'A::A::B', 'A::B'], classes.drop(1).map(&:superclass).map(&:full_name) - end - - def test_pseudo_recursive_superclass - util_parser <<~RUBY - module Foo - class Bar - class Foo < Bar; end - # This class definition is used in OpenSSL::Cipher::Cipher - class Bar < Bar; end - class Baz < Bar; end - end - end - RUBY - foo_klass = @store.find_class_named 'Foo::Bar::Foo' - bar_klass = @store.find_class_named 'Foo::Bar::Bar' - baz_klass = @store.find_class_named 'Foo::Bar::Baz' - assert_equal 'Foo::Bar', foo_klass.superclass.full_name - assert_equal 'Foo::Bar', bar_klass.superclass.full_name - assert_equal 'Foo::Bar::Bar', baz_klass.superclass.full_name - end - - def test_class_module_nodoc - util_parser <<~RUBY - class Foo # :nodoc: - end - - class Bar - end # :nodoc: - - class Baz; end - - class Baz::A; end # :nodoc: - - module MFoo # :nodoc: - end - - module MBar - end # :nodoc: - - module MBaz; end - - module MBaz::M; end; # :nodoc: - RUBY - documentables = @store.all_classes_and_modules.select(&:document_self) - assert_equal ['Baz', 'MBaz'], documentables.map(&:full_name) unless accept_legacy_bug? - end - - def test_class_module_stopdoc - util_parser <<~RUBY - # comment - class Foo - class A; end - # :stopdoc: - class B; end - end - - # comment - module Bar - module A; end - # :stopdoc: - module B; end - end - RUBY - klass = @top_level.classes.first - mod = @top_level.modules.first - assert_equal 'comment', klass.comment.text.strip - assert_equal 'comment', mod.comment.text.strip - assert_equal ['Foo::A'], klass.classes.select(&:document_self).map(&:full_name) - assert_equal ['Bar::A'], mod.modules.select(&:document_self).map(&:full_name) - end - - def test_class_superclass - util_parser <<~RUBY - class Foo; end - class Bar < Foo - end - class Baz < (any expression) - end - RUBY - assert_equal ['Foo', 'Bar', 'Baz'], @top_level.classes.map(&:full_name) - foo, bar, baz = @top_level.classes - assert_equal foo, bar.superclass - assert_equal 'Object', baz.superclass unless accept_legacy_bug? - end - - def test_class_new_notnew - util_parser <<~RUBY - class A - def initialize(*args); end - end - - class B - ## - # :args: a, b, c - def initialize(*args); end - end - - class C - def self.initialize(*args); end - end - - class D - ## - # :args: a, b, c - def initialize(*args); end # :notnew: - end - - class E - def initialize(*args); end # :not-new: - end - - class F - def initialize(*args); end # :not_new: - end - - class G - def initialize(*args) - end # :notnew: - end - RUBY - - expected = [ - 'new(*args)', 'new(a, b, c)', - 'initialize(*args)', 'initialize(a, b, c)', - 'initialize(*args)', 'initialize(*args)', - 'initialize(*args)' - ] - arglists = @top_level.classes.map { |c| c.method_list.first.arglists } - assert_equal expected, arglists - end - - def test_class_mistaken_for_module - util_parser <<~RUBY - class A::Foo; end - class B::Foo; end - module C::Bar; end - module D::Baz; end - class A; end - class X < C; end - RUBY - assert_equal ['A', 'C', 'X'], @top_level.classes.map(&:full_name) - assert_equal ['B', 'D'], @top_level.modules.map(&:full_name) - end - - def test_parenthesized_cdecl - util_parser <<~RUBY - module DidYouMean - # Not a module, but creates a dummy module for document - class << (NameErrorCheckers = Object.new) - def new; end - end - end - RUBY - - mod = @store.find_class_or_module('DidYouMean').modules.first - assert_equal 'DidYouMean::NameErrorCheckers', mod.full_name - assert_equal ['DidYouMean::NameErrorCheckers::new'], mod.method_list.map(&:full_name) - end - - - def test_ghost_method - util_parser <<~RUBY - class Foo - ## - # :method: one - # - # my method one - - ## - # :method: - # :call-seq: - # two(name) - # - # my method two - - ## - # :method: three - # :args: a, b - # - # my method three - - # :stopdoc: - - ## - # :method: hidden1 - # - # comment - - ## - # :method: - # :call-seq: - # hidden2(name) - # - # comment - end - RUBY - - klass = @store.find_class_named 'Foo' - assert_equal 3, klass.method_list.size - one, two, three = klass.method_list - assert_equal 'Foo#one', one.full_name - assert_equal 'Foo#two', two.full_name - assert_equal 'Foo#three', three.full_name - assert_equal 'two(name)', two.call_seq.chomp - assert_equal 'three(a, b)', three.arglists - assert_equal 'my method one', one.comment.text.strip - assert_equal 'my method two', two.comment.text.strip - assert_equal 'my method three', three.comment.text.strip - assert_equal 3, one.line - assert_equal 8, two.line - assert_equal 15, three.line - assert_equal @top_level, one.file - assert_equal @top_level, two.file - assert_equal @top_level, three.file - end - - def test_invalid_meta_method - util_parser <<~RUBY - class Foo - # These are invalid meta method comments - # because meta method comment should start with `##` - # but rdoc accepts them as meta method comments for now. - - # :method: m1 - - # :singleton-method: sm1 - - # :attr: a1 - - # :attr_reader: ar1 - - # :attr_writer: aw1 - - # :attr_accessor: arw1 - - # If there is a node following meta-like normal comment, it is not a meta method comment - - # :method: m2 - add_my_method(name) - - # :singleton-method: sm2 - add_my_singleton_method(name) - - # :method: - add_my_method(:m3) - - # :singleton-method: - add_my_singleton_method(:sm3) - - # :attr: - add_my_attribute(:a2) - - # :attr-reader: - add_my_attribute(:ar2) - - # :attr-writer: - add_my_attribute(:aw2) - - # :attr-accessor: - add_my_attribute(:arw2) - - # :attr: a3 - add_my_attribute_a3 - - # :attr-reader: ar3 - add_my_attribute_ar3 - - # :attr-writer: aw3 - add_my_attribute_aw2 - - # :attr-accessor: arw3 - add_my_attribute_arw3 - end - RUBY - - klass = @store.find_class_named 'Foo' - assert_equal ['m1', 'sm1'], klass.method_list.map(&:name) - assert_equal ['a1', 'ar1', 'aw1', 'arw1'], klass.attributes.map(&:name) - end - - def test_unknown_meta_method - util_parser <<~RUBY - class Foo - ## - # :call-seq: - # two(name) - # - # method or singleton-method directive is missing - end - - class Bar - ## - # unknown meta method - add_my_method("foo" + "bar") - end - RUBY - - foo = @store.find_class_named 'Foo' - bar = @store.find_class_named 'Bar' - assert_equal [], foo.method_list.map(&:name) - assert_equal ['unknown'], bar.method_list.map(&:name) - end - - def test_method - util_parser <<~RUBY - class Foo - # my method one - def one; end - # my method two - def two(x); end - # my method three - def three x; end - end - RUBY - - klass = @store.find_class_named 'Foo' - assert_equal 3, klass.method_list.size - one, two, three = klass.method_list - assert_equal 'Foo#one', one.full_name - assert_equal 'Foo#two', two.full_name - assert_equal 'Foo#three', three.full_name - assert_equal 'one()', one.arglists - assert_equal 'two(x)', two.arglists - assert_equal 'three(x)', three.arglists unless accept_legacy_bug? - assert_equal 'my method one', one.comment.text.strip - assert_equal 'my method two', two.comment.text.strip - assert_equal 'my method three', three.comment.text.strip - assert_equal 3, one.line - assert_equal 5, two.line - assert_equal 7, three.line - assert_equal @top_level, one.file - assert_equal @top_level, two.file - assert_equal @top_level, three.file - end - - def test_method_toplevel - util_parser <<~RUBY - # comment - def foo; end - RUBY - - object = @store.find_class_named 'Object' - foo = object.method_list.first - assert_equal 'Object#foo', foo.full_name - assert_equal 'comment', foo.comment.text.strip - assert_equal @top_level, foo.file - end - - def test_meta_method - util_parser <<~RUBY - class Foo - ## - # my method - add_my_method :method_foo, :arg - end - RUBY - - klass = @store.find_class_named 'Foo' - assert_equal 1, klass.method_list.size - method = klass.method_list.first - assert_equal 'Foo#method_foo', method.full_name - assert_equal 'my method', method.comment.text.strip - assert_equal 4, method.line - assert_equal @top_level, method.file - end - - def test_first_comment_is_not_a_meta_method - util_parser <<~RUBY - ## - # first comment is not a meta method - add_my_method :foo - - ## - # this is a meta method - add_my_method :bar - RUBY - - object = @store.find_class_named 'Object' - assert_equal ['bar'], object.method_list.map(&:name) - end - - def test_meta_method_unknown - util_parser <<~RUBY - class Foo - ## - # my method - add_my_method (:foo), :bar - end - RUBY - - klass = @store.find_class_named 'Foo' - assert_equal 1, klass.method_list.size - method = klass.method_list.first - assert_equal 'Foo#unknown', method.full_name - assert_equal 'my method', method.comment.text.strip - assert_equal 4, method.line - assert_equal @top_level, method.file - end - - def test_meta_define_method - util_parser <<~RUBY - class Foo - ## - # comment 1 - define_method :foo do end - ## - # comment 2 - define_method :bar, ->{} - # not a meta comment, not a meta method - define_method :ignored do end - class << self - ## - # comment 3 - define_method :baz do end - end - end - RUBY - - klass = @store.find_class_named 'Foo' - klass.method_list.last.singleton = true if accept_legacy_bug? - assert_equal 3, klass.method_list.size - assert_equal ['Foo#foo', 'Foo#bar', 'Foo::baz'], klass.method_list.map(&:full_name) - assert_equal [false, false, true], klass.method_list.map(&:singleton) - assert_equal ['comment 1', 'comment 2', 'comment 3'], klass.method_list.map { |m| m.comment.text.strip } - assert_equal [4, 7, 13], klass.method_list.map(&:line) - assert_equal [@top_level] * 3, klass.method_list.map(&:file) - end - - def test_method_definition_nested_inside_block - util_parser <<~RUBY - module A - extend ActiveSupport::Concern - included do - ## - # :singleton-method: - # comment foo - mattr_accessor :foo - - ## - # :method: bar - # comment bar - add_my_method :bar - end - - tap do - # comment baz1 - def baz1; end - end - - self.tap do - # comment baz2 - def baz2; end - end - - my_decorator def self.baz3; end - - self.my_decorator def baz4; end - end - RUBY - mod = @store.find_module_named 'A' - methods = mod.method_list - assert_equal ['A::foo', 'A#bar', 'A#baz1', 'A#baz2', 'A::baz3', 'A#baz4'], methods.map(&:full_name) - assert_equal ['comment foo', 'comment bar', 'comment baz1', 'comment baz2'], methods.take(4).map { |m| m.comment.text.strip } - end - - def test_method_yields_directive - util_parser <<~RUBY - class Foo - def f1(a, &b); end - - def f2 - def o.foo - yield :dummy - end - yield - end - - def f3(&b) - yield a, *b, c: 1 - yield 1, 2, 3 - end - - def f4(a, &b) # :yields: d, e - yields 1, 2 - end - - def f5 # :yield: f - yields 1, 2 - end - - def f6; end # :yields: - - ## - # :yields: g, h - add_my_method :f7 - end - RUBY - - klass = @top_level.classes.first - methods = klass.method_list - expected = [ - 'f1(a, &b)', - 'f2() { || ... }', - 'f3() { |a, *b, c: 1| ... }', - 'f4(a) { |d, e| ... }', - 'f5() { |f| ... }', - 'f6() { || ... }', - 'f7() { |g, h| ... }' - ] - assert_equal expected, methods.map(&:arglists) - end - - def test_calls_super - util_parser <<~RUBY - class A - def m1; foo; bar; end - def m2; if cond; super(a); end; end # SuperNode - def m3; tap do; super; end; end # ForwardingSuperNode - def m4; def a.b; super; end; end # super inside another method - end - RUBY - - klass = @store.find_class_named 'A' - methods = klass.method_list - assert_equal ['m1', 'm2', 'm3', 'm4'], methods.map(&:name) - assert_equal [false, true, true, false], methods.map(&:calls_super) - end - - def test_method_args_directive - util_parser <<~RUBY - class Foo - def method1 # :args: a, b, c - end - - ## - # :args: d, e, f - def method2(*args); end - - ## - # :args: g, h - add_my_method :method3 - end - RUBY - - klass = @top_level.classes.first - methods = klass.method_list - assert_equal ['method1(a, b, c)', 'method2(d, e, f)', 'method3(g, h)'], methods.map(&:arglists) - end - - def test_class_repeatedly - util_parser <<~RUBY - class Foo - def foo; end - end - class Foo - def bar; end - end - RUBY - util_parser <<~RUBY - class Foo - def baz; end - end - RUBY - - klass = @store.find_class_named 'Foo' - assert_equal ['Foo#foo', 'Foo#bar', 'Foo#baz'], klass.method_list.map(&:full_name) - end - - def test_undefined_singleton_class_defines_module - util_parser <<~RUBY - class << Foo - end - class << ::Bar - end - RUBY - - modules = @store.all_modules - assert_equal ['Foo', 'Bar'], modules.map(&:name) - end - - def test_singleton_class - util_parser <<~RUBY - class A; end - class Foo - def self.m1; end - def (any expression).dummy1; end - class << self - def m2; end - def self.dummy2; end - end - class << A - def dummy3; end - end - class << Foo - def m3; end - def self.dummy4; end - end - class << ::Foo - def m4; end - end - class << (any expression) - def dummy5; end - end - end - class << Foo - def m5; end - end - class << ::Foo - def m6; end - end - RUBY - - klass = @store.find_class_named 'Foo' - methods = klass.method_list - methods = methods.reject {|m| m.name =~ /dummy2|dummy4/ } if accept_legacy_bug? - assert_equal ['m1', 'm2', 'm3', 'm4', 'm5', 'm6'], methods.map(&:name) - assert_equal [true] * 6, methods.map(&:singleton) - end - - def test_singleton_class_meta_method - util_parser <<~RUBY - class Foo - ## - # :singleton-method: m1 - - ## - # :singleton-method: - add_my_smethod :m2, :arg - - ## - # :singleton-method: - add_my_smethod 'm3', :arg - - # comment - class << self - ## - # method of a singleton class is a singleton method - # :method: m4 - - ## - # :singleton-method: m5 - end - end - RUBY - - klass = @store.find_class_named 'Foo' - assert_equal ['m1', 'm2', 'm3', 'm4', 'm5'], klass.method_list.map(&:name) - klass.method_list[3].singleton = true if accept_legacy_bug? - assert_equal [true] * 5, klass.method_list.map(&:singleton) - end - - def test_method_nested_visibility - util_parser <<~RUBY - class A - def pub1; end - private - def pri1; end - class B - def pub_b1; end - private - def pri_b1; end - public - def pub_b2; end - end - def pri2; end - end - class A - def pub2; end - private - def pri2; end - end - RUBY - klass_a = @store.find_class_named 'A' - klass_b = klass_a.find_class_named 'B' - public_a = klass_a.method_list.select { |m| m.visibility == :public }.map(&:name) - public_b = klass_b.method_list.select { |m| m.visibility == :public }.map(&:name) - assert_equal ['pub1', 'pub2'], public_a - assert_equal ['pub_b1', 'pub_b2'], public_b - end - - def test_attributes_visibility - util_parser <<~RUBY - class A - attr :pub_a - attr_reader :pub_r - attr_writer :pub_w - attr_accessor :pub_rw - private - attr :pri_a - attr_reader :pri_r - attr_writer :pri_w - attr_accessor :pri_rw - end - RUBY - klass = @store.find_class_named 'A' - assert_equal ['pub_a', 'pub_r', 'pub_w', 'pub_rw', 'pri_a', 'pri_r', 'pri_w', 'pri_rw'], klass.attributes.map(&:name) - assert_equal [:public] * 4 + [:private] * 4, klass.attributes.map(&:visibility) - end - - def test_method_singleton_class_visibility - util_parser <<~RUBY - class A - def self.pub1; end - private - def self.pub2; end - class << self - def pub3; end - private - def pri1; end - public - def pub4; end - private - end - end - RUBY - klass = @store.find_class_named 'A' - public_singleton_methods = klass.method_list.select { |m| m.singleton && m.visibility == :public } - assert_equal ['pub1', 'pub2', 'pub3', 'pub4'], public_singleton_methods.map(&:name) - end - - def test_private_def_public_def - util_parser <<~RUBY - class A - private def m1; end - public def m2; end - private - public def m3; end - end - RUBY - klass = @store.find_class_named 'A' - public_methods = klass.method_list.select { |m| m.visibility == :public } - assert_equal ['m2', 'm3'], public_methods.map(&:name) - end - - def test_define_method_visibility - util_parser <<~RUBY - class A - private - ## - # my private method - define_method :m1 do end - public - ## - # my public method - define_method :m2 do end - end - RUBY - klass = @store.find_class_named 'A' - methods = klass.method_list - assert_equal ['m1', 'm2'], methods.map(&:name) - assert_equal [:private, :public], methods.map(&:visibility) - end - - def test_module_function - util_parser <<~RUBY - class A - def m1; end - def m2; end - def m3; end - module_function :m1, :m3 - module_function def m4; end - end - RUBY - klass = @store.find_class_named 'A' - instance_methods = klass.method_list.reject(&:singleton) - singleton_methods = klass.method_list.select(&:singleton) - if accept_legacy_bug? - instance_methods.last.visibility = :private - singleton_methods << singleton_methods.last.dup - singleton_methods.last.name = 'm4' - end - assert_equal ['m1', 'm2', 'm3', 'm4'], instance_methods.map(&:name) - assert_equal [:private, :public, :private, :private], instance_methods.map(&:visibility) - assert_equal ['m1', 'm3', 'm4'], singleton_methods.map(&:name) - assert_equal [:public, :public, :public], singleton_methods.map(&:visibility) - end - - def test_class_method_visibility - util_parser <<~RUBY - class A - def self.m1; end - def self.m2; end - def self.m3; end - private_class_method :m1, :m2 - public_class_method :m1, :m3 - private_class_method def self.m4; end - public_class_method def self.m5; end - end - RUBY - klass = @store.find_class_named 'A' - public_methods = klass.method_list.select { |m| m.visibility == :public } - assert_equal ['m1', 'm3', 'm5'], public_methods.map(&:name) unless accept_legacy_bug? - end - - def test_method_change_visibility - util_parser <<~RUBY - class A - def m1; end - def m2; end - def m3; end - def m4; end - def m5; end - private :m2, :m3, :m4 - public :m1, :m3 - end - class << A - def m1; end - def m2; end - def m3; end - def m4; end - def m5; end - private :m1, :m2, :m3 - public :m2, :m4 - end - RUBY - klass = @store.find_class_named 'A' - public_methods = klass.method_list.select { |m| !m.singleton && m.visibility == :public } - public_singleton_methods = klass.method_list.select { |m| m.singleton && m.visibility == :public } - assert_equal ['m1', 'm3', 'm5'], public_methods.map(&:name) - assert_equal ['m2', 'm4', 'm5'], public_singleton_methods.map(&:name) - end - - def test_undocumentable_change_visibility - pend if accept_legacy_bug? - util_parser <<~RUBY - class A - def m1; end - def self.m2; end - private 42, :m # maybe not Module#private - # ignore all non-standard `private def` and `private_class_method def` - private def self.m1; end - private_class_method def m2; end - private def to_s.m1; end - private_class_method def to_s.m2; end - end - RUBY - klass = @store.find_class_named 'A' - assert_equal [:public] * 4, klass.method_list.map(&:visibility) - end - - def test_method_visibility_change_in_subclass - pend 'not implemented' if accept_legacy_bug? - util_parser <<~RUBY - class A - def m1; end - def m2; end - private :m2 - end - class B < A - private :m1 - public :m2 - end - RUBY - - superclass = @store.find_class_named('A') - klass = @store.find_class_named('B') - assert_equal ['m1', 'm2'], superclass.method_list.map(&:name) - assert_equal ['m1', 'm2'], klass.method_list.map(&:name) - assert_equal [:public, :private], superclass.method_list.map(&:visibility) - assert_equal [:private, :public], klass.method_list.map(&:visibility) - end - - def test_singleton_method_visibility_change_in_subclass - util_parser <<~RUBY - class A - def self.m1; end - def self.m2; end - private_class_method :m2 - end - class B < A - private_class_method :m1 - public_class_method :m2 - end - RUBY - - superclass = @store.find_class_named('A') - klass = @store.find_class_named('B') - assert_equal ['m1', 'm2'], superclass.method_list.map(&:name) - assert_equal ['m1', 'm2'], klass.method_list.map(&:name) - assert_equal [:public, :private], superclass.method_list.map(&:visibility) - assert_equal [:private, :public], klass.method_list.map(&:visibility) - end - - def test_alias - util_parser <<~RUBY - class Foo - def bar; end - def bar2; alias :dummy :bar; end - # comment - alias :baz1 :bar # :nodoc: - alias :baz2 :bar - # :stopdoc: - alias :baz3 :bar - end - RUBY - klass = @store.find_class_named 'Foo' - assert_equal ['Foo#bar', 'Foo#bar2', 'Foo#baz2'], klass.method_list.map(&:full_name) - m = klass.method_list.last - assert_equal 'Foo#bar', m.is_alias_for.full_name - assert_equal 'Foo#baz2', m.full_name - assert_equal klass, m.parent - end - - def test_alias_singleton - util_parser <<~RUBY - class Foo - class << self - def bar; end - # comment - alias :baz :bar - # :stopdoc: - alias :baz2 :bar - end - end - RUBY - klass = @store.find_class_named 'Foo' - m = klass.class_method_list.last - assert_equal 'Foo::bar', m.is_alias_for.full_name - assert_equal 'Foo::baz', m.full_name - assert_equal 'comment', m.comment.text - assert_equal klass, m.parent - end - - def test_alias_method - util_parser <<~RUBY - class Foo - def foo; end - private - alias_method :foo2, :foo - def bar; end - public - alias_method :bar2, :bar - private :foo - public :bar - end - RUBY - foo, foo2, bar, bar2 = @top_level.classes.first.method_list - assert_equal 'foo', foo.name - assert_equal 'bar', bar.name - assert_equal 'foo2', foo2.name - assert_equal 'bar2', bar2.name - assert_equal 'foo', foo2.is_alias_for.name - assert_equal 'bar', bar2.is_alias_for.name - unless accept_legacy_bug? - assert_equal :private, foo.visibility - assert_equal :public, foo2.visibility - assert_equal :public, bar.visibility - assert_equal :private, bar2.visibility - end - end - - def test_invalid_alias_method - pend if accept_legacy_bug? - util_parser <<~RUBY - class Foo - def foo; end - alias_method - alias_method :foo - alias_method :foo, :bar, :baz - alias_method 42, :foo - end - RUBY - assert_equal ['foo'], @top_level.classes.first.method_list.map(&:name) - end - - def test_alias_method_stopdoc_nodoc - util_parser <<~RUBY - class Foo - def foo; end - # :stopdoc: - alias_method :foo2, :foo - # :startdoc: - alias_method :foo3, :foo # :nodoc: - alias_method :foo4, :foo - end - RUBY - assert_equal ['foo', 'foo4'], @top_level.classes.first.method_list.map(&:name) - end - - def test_attributes - util_parser <<~RUBY - class Foo - # attrs - attr :attr1, :attr2 - # readers - attr_reader :reader1, :reader2 - # writers - attr_writer :writer1, :writer2 - # accessors - attr_accessor :accessor1, :accessor2 - # :stopdoc: - attr :attr3, :attr4 - attr_reader :reader3, :reader4 - attr_writer :write3, :writer4 - attr_accessor :accessor3, :accessor4 - end - RUBY - klass = @store.find_class_named 'Foo' - if accept_legacy_bug? - a, r1, r2, w1, w2, rw1, rw2 = klass.attributes - a1 = a.dup - a2 = a.dup - a1.rw = a2.rw = 'R' - a2.name = 'attr2' - else - assert_equal 8, klass.attributes.size - a1, a2, r1, r2, w1, w2, rw1, rw2 = klass.attributes - end - assert_equal ['attr1', 'attr2'], [a1.name, a2.name] - assert_equal ['reader1', 'reader2'], [r1.name, r2.name] - assert_equal ['writer1', 'writer2'], [w1.name, w2.name] - assert_equal ['accessor1', 'accessor2'], [rw1.name, rw2.name] - assert_equal ['R', 'R'], [a1.rw, a2.rw] - assert_equal ['R', 'R'], [r1.rw, r2.rw] - assert_equal ['W', 'W'], [w1.rw, w2.rw] - assert_equal ['RW', 'RW'], [rw1.rw, rw2.rw] - assert_equal ['attrs', 'attrs'], [a1.comment.text, a2.comment.text] - assert_equal ['readers', 'readers'], [r1.comment.text, r2.comment.text] - assert_equal ['writers', 'writers'], [w1.comment.text, w2.comment.text] - assert_equal ['accessors', 'accessors'], [rw1.comment.text, rw2.comment.text] - assert_equal [3, 3], [a1.line, a2.line] - assert_equal [5, 5], [r1.line, r2.line] - assert_equal [7, 7], [w1.line, w2.line] - assert_equal [9, 9], [rw1.line, rw2.line] - assert_equal [@top_level] * 8, [a1, a2, r1, r2, w1, w2, rw1, rw2].map(&:file) - end - - def test_undocumentable_attributes - util_parser <<~RUBY - class Foo - attr - attr 42, :foo - end - RUBY - klass = @store.find_class_named 'Foo' - assert_empty klass.method_list - assert_empty klass.attributes - end - - def test_singleton_class_attributes - util_parser <<~RUBY - class Foo - class << self - attr :a - attr_reader :r - attr_writer :w - attr_accessor :rw - end - end - RUBY - klass = @store.find_class_named 'Foo' - attributes = klass.attributes - assert_equal ['a', 'r', 'w', 'rw'], attributes.map(&:name) - assert_equal [true] * 4, attributes.map(&:singleton) - end - - def test_attributes_nodoc - util_parser <<~RUBY - class Foo - attr :attr1, :attr2 # :nodoc: - attr :attr3 - attr_reader :reader1, :reader2 # :nodoc: - attr_reader :reader3 - attr_writer :writer1, :writer2 # :nodoc: - attr_writer :writer3 - attr_accessor :accessor1, :accessor2 # :nodoc: - attr_accessor :accessor3 - end - RUBY - klass = @store.find_class_named 'Foo' - unless accept_legacy_bug? - assert_equal 4, klass.attributes.size - end - end - - def test_attributes_nodoc_track - @options.visibility = :nodoc - util_parser <<~RUBY - class Foo - attr :attr1, :attr2 # :nodoc: - attr :attr3 - attr_reader :reader1, :reader2 # :nodoc: - attr_reader :reader3 - attr_writer :writer1, :writer2 # :nodoc: - attr_writer :writer3 - attr_accessor :accessor1, :accessor2 # :nodoc: - attr_accessor :accessor3 - end - RUBY - klass = @store.find_class_named 'Foo' - unless accept_legacy_bug? - assert_equal 12, klass.attributes.size - end - end - - def test_method_nodoc_stopdoc - util_parser <<~RUBY - class Foo - def doc1; end - def nodoc1; end # :nodoc: - def doc2; end - def nodoc2 # :nodoc: - end - def doc3; end - def nodoc3 - end # :nodoc: - def doc4; end - # :stopdoc: - def nodoc4; end - end - RUBY - klass = @store.find_class_named 'Foo' - assert_equal ['doc1', 'doc2', 'doc3', 'doc4'], klass.method_list.map(&:name) - end - - def test_method_nodoc_track - @options.visibility = :nodoc - util_parser <<~RUBY - class Foo - def doc1; end - def nodoc1; end # :nodoc: - def doc2; end - def nodoc2 # :nodoc: - end - def doc3; end - def nodoc3 - end # :nodoc: - def doc4; end - end - RUBY - klass = @store.find_class_named 'Foo' - assert_equal ['doc1', 'nodoc1', 'doc2', 'nodoc2', 'doc3', 'nodoc3', 'doc4'], klass.method_list.map(&:name) - assert_equal [true, nil, true, nil, true, nil, true], klass.method_list.map(&:document_self) - end - - def test_meta_attributes - util_parser <<~RUBY - class Foo - ## - # :attr: - # attrs - add_my_method :attr1, :attr2 - ## - # :attr_reader: - # readers - add_my_method :reader1, :reader2 - ## - # :attr_writer: - # writers - add_my_method :writer1, :writer2 - ## - # :attr_accessor: - # accessors - add_my_method :accessor1, :accessor2 - - # :stopdoc: - - ## - # :attr: - add_my_method :attr3 - ## - # :attr_reader: - add_my_method :reader3 - ## - # :attr_writer: - add_my_method :writer3 - ## - # :attr_accessor: - add_my_method :accessor3 - end - RUBY - klass = @store.find_class_named 'Foo' - assert_equal 8, klass.attributes.size - a1, a2, r1, r2, w1, w2, rw1, rw2 = klass.attributes - assert_equal ['attr1', 'attr2'], [a1.name, a2.name] - assert_equal ['reader1', 'reader2'], [r1.name, r2.name] - assert_equal ['writer1', 'writer2'], [w1.name, w2.name] - assert_equal ['accessor1', 'accessor2'], [rw1.name, rw2.name] - a1.rw = a2.rw = 'R' if accept_legacy_bug? - assert_equal ['R', 'R'], [a1.rw, a2.rw] - assert_equal ['R', 'R'], [r1.rw, r2.rw] - assert_equal ['W', 'W'], [w1.rw, w2.rw] - assert_equal ['RW', 'RW'], [rw1.rw, rw2.rw] - assert_equal ['attrs', 'attrs'], [a1.comment.text, a2.comment.text] - assert_equal ['readers', 'readers'], [r1.comment.text, r2.comment.text] - assert_equal ['writers', 'writers'], [w1.comment.text, w2.comment.text] - assert_equal ['accessors', 'accessors'], [rw1.comment.text, rw2.comment.text] - assert_equal [@top_level] * 8, [a1, a2, r1, r2, w1, w2, rw1, rw2].map(&:file) - end - - def test_meta_attributes_named - util_parser <<~RUBY - class Foo - ## - # comment a - # :attr: attr1 - add_my_method :a1 - ## - # comment r - # :attr_reader: reader1 - add_my_method :r1 - ## - # comment w - # :attr_writer: writer1 - add_my_method :w1 - ## - # comment rw - # :attr_accessor: accessor1 - add_my_method :rw1 - - # :stopdoc: - - ## - # :attr: attr2 - add_my_method :a2 - ## - # :attr_reader: reader2 - add_my_method :r2 - ## - # :attr_writer: writer2 - add_my_method :w2 - ## - # :attr_accessor: accessor2 - add_my_method :rw2 - end - RUBY - klass = @store.find_class_named 'Foo' - assert_equal 4, klass.attributes.size - a, r, w, rw = klass.attributes - assert_equal 'attr1', a.name - assert_equal 'reader1', r.name - assert_equal 'writer1', w.name - assert_equal 'accessor1', rw.name - a.rw = 'R' if accept_legacy_bug? - assert_equal 'R', a.rw - assert_equal 'R', r.rw - assert_equal 'W', w.rw - assert_equal 'RW', rw.rw - assert_equal 'comment a', a.comment.text - assert_equal 'comment r', r.comment.text - assert_equal 'comment w', w.comment.text - assert_equal 'comment rw', rw.comment.text - assert_equal [@top_level] * 4, [a, r, w, rw].map(&:file) - end - - def test_constant - util_parser <<~RUBY - class Foo - A = (any expression 1) - def f - DUMMY1 = (any expression 2) - end - class Bar; end - Bar::B = (any expression 3) - ::C = (any expression 4) - # :stopdoc: - DUMMY2 = 1 - # :startdoc: - D = (any expression 5) - E = (any expression 6) # :nodoc: - F = ( - any expression 7 - ) # :nodoc: - end - G = (any expression 8) - RUBY - foo = @top_level.classes.first - bar = foo.classes.first - object = @top_level.find_class_or_module('Object') - assert_equal ['A', 'D', 'E', 'F'], foo.constants.map(&:name) unless accept_legacy_bug? - assert_equal '(any expression 1)', foo.constants.first.value - assert_equal ['B'], bar.constants.map(&:name) - assert_equal ['C', 'G'], object.constants.map(&:name) unless accept_legacy_bug? - all_constants = foo.constants + bar.constants + object.constants - assert_equal [@top_level] * 7, all_constants.map(&:file) unless accept_legacy_bug? - assert_equal [2, 12, 13, 14, 7, 8, 18], all_constants.map(&:line) unless accept_legacy_bug? - end - - def test_nodoc_constant_assigned_without_nodoc_comment - util_parser <<~RUBY - module Foo - A = 1 - B = 1 # :nodoc: - begin - C = 1 # :nodoc: - rescue - C = 2 - end - end - Foo::B = 2 - Foo::D = 2 - RUBY - mod = @top_level.modules.first - assert_equal ['A', 'B', 'C', 'D'], mod.constants.map(&:name) - assert_equal [false, true, true, false], mod.constants.map(&:received_nodoc) - end - - def test_constant_visibility - util_parser <<~RUBY - class C - A = 1 - B = 2 - C = 3 - private_constant - private_constant foo - private_constant :A - private_constant :B, :C - public_constant :B - end - RUBY - klass = @store.find_class_named 'C' - const_a, const_b, const_c = klass.constants.sort_by(&:name) - - assert_equal 'A', const_a.name - assert_equal :private, const_a.visibility - - assert_equal 'B', const_b.name - assert_equal :public, const_b.visibility - - assert_equal 'C', const_c.name - assert_equal :private, const_c.visibility - end - - def test_constant_assignment_to_undefined_module_path - util_parser <<~RUBY - A::B::C = 1 - RUBY - a = @top_level.find_module_named 'A' - b = a.find_module_named 'B' - c = b.constants.first - assert_equal 'A::B::C', c.full_name - end - - def test_constant_alias - util_parser <<~RUBY - class Foo - class Bar; end - A = Bar - # B = ::Foo # master branch has bug - C = Foo::Bar - end - RUBY - klass = @top_level.classes.first - assert_equal [], klass.modules.map(&:full_name) - assert_equal ['Foo::Bar', 'Foo::A', 'Foo::C'], klass.classes.map(&:full_name) - assert_equal ['Foo::A', 'Foo::C'], klass.constants.map(&:full_name) - assert_equal 'Foo::A', klass.find_module_named('A').full_name - assert_equal 'Foo::C', klass.find_module_named('C').full_name - end - - def test_constant_method - util_parser <<~RUBY - def Object.foo; end - class A - class B - class C - def B.bar; end - end - end - end - def UNKNOWN.baz; end - RUBY - - object = @store.find_class_named 'Object' - klass = @store.find_class_named 'A::B' - unknown = @store.find_module_named('UNKNOWN') - assert_equal 'Object::foo', object.method_list.first.full_name - assert_equal 'A::B::bar', klass.method_list.first.full_name - assert_equal 'UNKNOWN::baz', unknown.method_list.first.full_name - end - - def test_true_false_nil_method - util_parser <<~RUBY - def nil.foo; end - def true.bar; end - def false.baz; end - RUBY - sep = accept_legacy_bug? ? '::' : '#' - assert_equal "NilClass#{sep}foo", @store.find_class_named('NilClass').method_list.first.full_name - assert_equal "TrueClass#{sep}bar", @store.find_class_named('TrueClass').method_list.first.full_name - assert_equal "FalseClass#{sep}baz", @store.find_class_named('FalseClass').method_list.first.full_name - end - - def test_include_extend - util_parser <<~RUBY - module I; end - module E; end - class C - # my include - include I - # my extend - extend E - end - module M - include I - extend E - end - RUBY - klass = @store.find_class_named 'C' - mod = @store.find_module_named 'M' - assert_equal ['I'], klass.includes.map(&:name) - assert_equal ['E'], klass.extends.map(&:name) - assert_equal ['I'], mod.includes.map(&:name) - assert_equal ['E'], mod.extends.map(&:name) - assert_equal 'my include', klass.includes.first.comment.text.strip - assert_equal 'my extend', klass.extends.first.comment.text.strip - end - - def test_include_extend_to_singleton_class - pend 'not implemented' if accept_legacy_bug? - util_parser <<~RUBY - class Foo - class << self - # include to singleton class is extend - include I - # extend to singleton class is not documentable - extend E - end - end - RUBY - - klass = @top_level.classes.first - assert_equal [], klass.includes.map(&:name) - assert_equal ['I'], klass.extends.map(&:name) - end - - def test_include_with_module_nesting - util_parser <<~RUBY - module A - module M; end - module B - module M; end - module C - module M; end - module D - module M; end - end - end - end - end - - module A::B - class C::D::Foo - include M - end - end - # TODO: make test pass with the following code appended - # module A::B::C - # class D::Foo - # include M - # end - # end - RUBY - klass = @store.find_class_named 'A::B::C::D::Foo' - assert_equal 'A::B::M', klass.includes.first.module.full_name - end - - def test_various_argument_include - pend 'not implemented' if accept_legacy_bug? - util_parser <<~RUBY - module A; end - module B; end - module C; end - class A - include - include A, B - include 42, C # Maybe not Module#include - end - RUBY - klass = @top_level.classes.first - assert_equal ['A', 'B'], klass.includes.map(&:name) - end - - def test_require - util_parser <<~RUBY - require - require 'foo/bar' - require_relative 'is/not/supported/yet' - require "\#{embed}" - require (any expression) - RUBY - assert_equal ['foo/bar'], @top_level.requires.map(&:name) - end - - def test_statements_identifier_alias_method_before_original_method - # This is not strictly legal Ruby code, but it simulates finding an alias - # for a method before finding the original method, which might happen - # to rdoc if the alias is in a different file than the original method - # and rdoc processes the alias' file first. - util_parser <<~RUBY - class Foo - alias_method :foo2, :foo - alias_method :foo3, :foo - end - - class Foo - def foo(); end - alias_method :foo4, :foo - alias_method :foo5, :unknown - end - RUBY - - foo = @top_level.classes.first.method_list[0] - assert_equal 'foo', foo.name - - foo2 = @top_level.classes.first.method_list[1] - assert_equal 'foo2', foo2.name - assert_equal 'foo', foo2.is_alias_for.name - - foo3 = @top_level.classes.first.method_list[2] - assert_equal 'foo3', foo3.name - assert_equal 'foo', foo3.is_alias_for.name - - foo4 = @top_level.classes.first.method_list.last - assert_equal 'foo4', foo4.name - assert_equal 'foo', foo4.is_alias_for.name - - assert_equal 'unknown', @top_level.classes.first.external_aliases[0].old_name - end - - def test_class_definition_encountered_after_class_reference - # The code below is not legal Ruby (Foo must have been defined before - # Foo.bar is encountered), but RDoc might encounter Foo.bar before Foo if - # they live in different files. - - util_parser <<-RUBY - def Foo.bar - end - - class Foo < IO - end - RUBY - - assert_empty @store.modules_hash - assert_empty @store.all_modules - - klass = @top_level.classes.first - assert_equal 'Foo', klass.full_name - assert_equal 'IO', klass.superclass - - assert_equal 'bar', klass.method_list.first.name - end - - def test_scan_duplicate_module - util_parser <<~RUBY - # comment a - module Foo - end - - # comment b - module Foo - end - RUBY - - mod = @top_level.modules.first - - expected = [ - RDoc::Comment.new('comment a', @top_level), - RDoc::Comment.new('comment b', @top_level) - ] - - assert_equal expected, mod.comment_location.map { |c, _l| c } - end - - def test_enddoc - util_parser <<~RUBY - class A - class B; end - # :enddoc: - # :startdoc: - class C; end - end - class D; end - # :enddoc: - # :startdoc: - class E; end - RUBY - - assert_equal ['A', 'A::B', 'D'], @store.all_classes.reject(&:ignored?).map(&:full_name) - end - - def test_top_level_enddoc - util_parser <<~RUBY - class A; end - # :enddoc: - class B; end - # :startdoc: - class C; end - RUBY - - assert_equal ['A'], @top_level.classes.reject(&:ignored?).map(&:name) - end - - def test_section - util_parser <<~RUBY - class Foo - # :section: section1 - attr :a1 - def m1; end - # :section: - def m2; end - attr :a2 - # :section: section2 - def m3; end - attr :a3 - module Bar - def m4; end - attr :a4 - # :section: section3 - def m5; end - attr :a5 - end - attr :a6 - def m6; end - end - RUBY - foo = @top_level.classes.first - bar = foo.modules.first - assert_equal ['section1', nil, 'section2', 'section2'], foo.attributes.map { |m| m.section.title } - assert_equal ['section1', nil, 'section2', 'section2'], foo.method_list.map { |m| m.section.title } - assert_equal [nil, 'section3'], bar.attributes.map { |m| m.section.title } - assert_equal [nil, 'section3'], bar.method_list.map { |m| m.section.title } - end - - def test_category - util_parser <<~RUBY - class A - # :category: cat1 - - # comment - attr :a1 - attr :a2 - def m1; end - # :category: cat2 - - # comment - def m2; end - def m3; end - attr :a3 - - # :category: - attr :a4 - # :category: - def m4; end - - ## - # :category: cat3 - def m5; end - - ## - # :category: cat4 - # :method: m6 - end - RUBY - klass = @top_level.classes.first - assert_equal ['cat1', nil, nil, nil], klass.attributes.map { |m| m.section.title } - assert_equal [nil, 'cat2', nil, nil, 'cat3', 'cat4'], klass.method_list.map { |m| m.section.title } - end - - def test_ignore_constant_assign_rhs - # Struct is not supported yet. Right hand side of constant assignment should be ignored. - util_parser <<~RUBY - module Foo - def a; end - Bar = Struct.new do - def b; end - ## - # :method: c - end - Bar::Baz = Struct.new do - def d; end - ## - # :method: e - end - ## - # :method: f - end - RUBY - mod = @top_level.modules.first - assert_equal ['a', 'f'], mod.method_list.map(&:name) - end - - def test_multibyte_method_name - content = <<~RUBY - class Foo - # comment ω - def ω() end - end - RUBY - util_parser content - assert_equal Encoding::UTF_8, content.encoding - method = @top_level.classes.first.method_list.first - assert_equal 'comment ω', method.comment.text.strip - assert_equal 'ω', method.name - end - - def test_options_encoding - @options.encoding = Encoding::CP852 - util_parser <<~RUBY - class Foo - ## - # this is my method - add_my_method :foo - end - RUBY - foo = @top_level.classes.first.method_list.first - assert_equal 'foo', foo.name - assert_equal 'this is my method', foo.comment.text - assert_equal Encoding::CP852, foo.comment.text.encoding - end - - def test_read_directive_linear_performance - assert_linear_performance((1..5).map{|i|10**i}) do |i| - util_parser '# ' + '0'*i + '=000:' + "\n def f; end" - end - end - - - def test_markup_first_comment - util_parser <<~RUBY - # :markup: rd - - # ((*awesome*)) - class C - # ((*radical*)) - def m - end - end - RUBY - - c = @top_level.classes.first - assert_equal 'rd', c.comment.format - assert_equal 'rd', c.method_list.first.comment.format - end - - def test_markup_override - util_parser <<~RUBY - # *awesome* - class C - # :markup: rd - # ((*radical*)) - def m1; end - - # *awesome* - def m2; end - end - RUBY - - c = @top_level.classes.first - - assert_equal 'rdoc', c.comment.format - - assert_equal ['rd', 'rdoc'], c.method_list.map { |m| m.comment.format } - end - - def test_tomdoc_meta - util_parser <<~RUBY - # :markup: tomdoc - - class C - - # Signature - # - # find_by_<field>[_and_<field>...](args) - # - # field - A field name. - - end - RUBY - - c = @top_level.classes.first - - m = c.method_list.first - - assert_equal "find_by_<field>[_and_<field>...]", m.name - assert_equal "find_by_<field>[_and_<field>...](args)\n", m.call_seq - - expected = - doc( - head(3, 'Signature'), - list(:NOTE, - item(%w[field], - para('A field name.')))) - expected.file = @top_level - - assert_equal expected, m.comment.parse - end -end - -class TestRDocParserPrismRuby < RDoc::TestCase - include RDocParserPrismTestCases - - def accept_legacy_bug? - false - end - - def util_parser(content) - @parser = RDoc::Parser::PrismRuby.new @top_level, @filename, content, @options, @stats - @parser.scan - end -end - -# Run the same test with the original RDoc::Parser::Ruby -class TestRDocParserRubyWithPrismRubyTestCases < RDoc::TestCase - include RDocParserPrismTestCases - - def accept_legacy_bug? - true - end - - def util_parser(content) - @parser = RDoc::Parser::Ruby.new @top_level, @filename, content, @options, @stats - @parser.scan - end -end unless ENV['RDOC_USE_PRISM_PARSER'] diff --git a/test/rdoc/test_rdoc_parser_rd.rb b/test/rdoc/test_rdoc_parser_rd.rb deleted file mode 100644 index 48663e6d7d..0000000000 --- a/test/rdoc/test_rdoc_parser_rd.rb +++ /dev/null @@ -1,55 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocParserRd < RDoc::TestCase - - def setup - super - - @RP = RDoc::Parser - - @tempfile = Tempfile.new self.class.name - filename = @tempfile.path - - @top_level = @store.add_file filename - @fn = filename - @options = RDoc::Options.new - @stats = RDoc::Stats.new @store, 0 - end - - def teardown - super - - @tempfile.close! - end - - def test_file - assert_kind_of RDoc::Parser::Text, util_parser('') - end - - def test_class_can_parse - temp_dir do - FileUtils.touch 'foo.rd' - assert_equal @RP::RD, @RP.can_parse('foo.rd') - - FileUtils.touch 'foo.rd.ja' - assert_equal @RP::RD, @RP.can_parse('foo.rd.ja') - end - end - - def test_scan - parser = util_parser 'it ((*really*)) works' - - expected = doc(para('it <em>really</em> works')) - expected.file = @top_level - - parser.scan - - assert_equal expected, @top_level.comment.parse - end - - def util_parser content - RDoc::Parser::RD.new @top_level, @fn, content, @options, @stats - end - -end diff --git a/test/rdoc/test_rdoc_parser_ruby.rb b/test/rdoc/test_rdoc_parser_ruby.rb deleted file mode 100644 index cf02a035a6..0000000000 --- a/test/rdoc/test_rdoc_parser_ruby.rb +++ /dev/null @@ -1,4400 +0,0 @@ -# frozen_string_literal: true - -require_relative 'helper' - -return if ENV['RDOC_USE_PRISM_PARSER'] - -class TestRDocParserRuby < RDoc::TestCase - - def setup - super - - @tempfile = Tempfile.new self.class.name - @filename = @tempfile.path - - # Some tests need two paths. - @tempfile2 = Tempfile.new self.class.name - @filename2 = @tempfile2.path - - @top_level = @store.add_file @filename - @top_level2 = @store.add_file @filename2 - - @options = RDoc::Options.new - @options.quiet = true - @options.option_parser = OptionParser.new - - @comment = RDoc::Comment.new '', @top_level - - @stats = RDoc::Stats.new @store, 0 - end - - def teardown - super - - @tempfile.close! - @tempfile2.close! - end - - def test_collect_first_comment - p = util_parser <<-CONTENT -# first - -# second -class C; end - CONTENT - - comment = p.collect_first_comment - - assert_equal RDoc::Comment.new("# first\n", @top_level), comment - end - - def test_collect_first_comment_encoding - @options.encoding = Encoding::CP852 - - p = util_parser <<-CONTENT -# first - -# second -class C; end - CONTENT - - comment = p.collect_first_comment - - assert_equal Encoding::CP852, comment.text.encoding - end - - def test_collect_first_comment_rd_hash - parser = util_parser <<-CONTENT -=begin -first -=end - -# second -class C; end - CONTENT - - comment = parser.collect_first_comment - - assert_equal RDoc::Comment.new("first\n", @top_level), comment - end - - def test_get_class_or_module - ctxt = RDoc::Context.new - ctxt.store = @store - - cont, name_t, given_name = util_parser('A') .get_class_or_module ctxt - - assert_equal ctxt, cont - assert_equal 'A', name_t[:text] - assert_equal 'A', given_name - - cont, name_t, given_name = util_parser('B::C') .get_class_or_module ctxt - - b = @store.find_module_named('B') - assert_equal b, cont - assert_equal [@top_level], b.in_files - assert_equal 'C', name_t[:text] - assert_equal 'B::C', given_name - - cont, name_t, given_name = util_parser('D:: E').get_class_or_module ctxt - - assert_equal @store.find_module_named('D'), cont - assert_equal 'E', name_t[:text] - assert_equal 'D::E', given_name - - assert_nothing_raised do - util_parser("A::\nB").get_class_or_module ctxt - end - end - - def test_get_class_or_module_document_children - ctxt = @top_level.add_class RDoc::NormalClass, 'A' - ctxt.stop_doc - - util_parser('B::C').get_class_or_module ctxt - - b = @store.find_module_named('A::B') - assert b.ignored? - - d = @top_level.add_class RDoc::NormalClass, 'A::D' - - util_parser('D::E').get_class_or_module ctxt - - refute d.ignored? - end - - def test_get_class_or_module_ignore_constants - ctxt = RDoc::Context.new - ctxt.store = @store - - util_parser('A') .get_class_or_module ctxt, true - util_parser('A::B').get_class_or_module ctxt, true - - assert_empty ctxt.constants - assert_empty @store.modules_hash.keys - assert_empty @store.classes_hash.keys - end - - def test_get_class_specification - assert_equal 'A', util_parser('A') .get_class_specification - assert_equal 'A::B', util_parser('A::B').get_class_specification - assert_equal '::A', util_parser('::A').get_class_specification - - assert_equal 'self', util_parser('self').get_class_specification - - assert_equal '', util_parser('').get_class_specification - - assert_equal '', util_parser('$g').get_class_specification - end - - def test_get_symbol_or_name - util_parser "* & | + 5 / 4" - - assert_equal '*', @parser.get_symbol_or_name - - @parser.skip_tkspace - - assert_equal '&', @parser.get_symbol_or_name - - @parser.skip_tkspace - - assert_equal '|', @parser.get_symbol_or_name - - @parser.skip_tkspace - - assert_equal '+', @parser.get_symbol_or_name - - @parser.skip_tkspace - @parser.get_tk - @parser.skip_tkspace - - assert_equal '/', @parser.get_symbol_or_name - end - - def test_suppress_parents - a = @top_level.add_class RDoc::NormalClass, 'A' - b = a.add_class RDoc::NormalClass, 'B' - c = b.add_class RDoc::NormalClass, 'C' - - util_parser '' - - @parser.suppress_parents c, a - - assert c.suppressed? - assert b.suppressed? - refute a.suppressed? - end - - def test_suppress_parents_documented - a = @top_level.add_class RDoc::NormalClass, 'A' - b = a.add_class RDoc::NormalClass, 'B' - b.add_comment RDoc::Comment.new("hello"), @top_level - c = b.add_class RDoc::NormalClass, 'C' - - util_parser '' - - @parser.suppress_parents c, a - - assert c.suppressed? - refute b.suppressed? - refute a.suppressed? - end - - def test_look_for_directives_in_attr - util_parser "" - - comment = RDoc::Comment.new "# :attr: my_attr\n", @top_level - - @parser.look_for_directives_in @top_level, comment - - assert_equal "# :attr: my_attr\n", comment.text - - comment = RDoc::Comment.new "# :attr_reader: my_method\n", @top_level - - @parser.look_for_directives_in @top_level, comment - - assert_equal "# :attr_reader: my_method\n", comment.text - - comment = RDoc::Comment.new "# :attr_writer: my_method\n", @top_level - - @parser.look_for_directives_in @top_level, comment - - assert_equal "# :attr_writer: my_method\n", comment.text - end - - def test_look_for_directives_in_commented - util_parser "" - - comment = RDoc::Comment.new <<-COMMENT, @top_level -# how to make a section: -# # :section: new section - COMMENT - - @parser.look_for_directives_in @top_level, comment - - section = @top_level.current_section - assert_nil section.title - assert_nil section.comment - - assert_equal "# how to make a section:\n# # :section: new section\n", - comment.text - end - - def test_look_for_directives_in_method - util_parser "" - - comment = RDoc::Comment.new "# :method: my_method\n", @top_level - - @parser.look_for_directives_in @top_level, comment - - assert_equal "# :method: my_method\n", comment.text - - comment = RDoc::Comment.new "# :singleton-method: my_method\n", @top_level - - @parser.look_for_directives_in @top_level, comment - - assert_equal "# :singleton-method: my_method\n", comment.text - end - - def test_look_for_directives_in_section - util_parser "" - - comment = RDoc::Comment.new <<-COMMENT, @top_level -# :section: new section -# woo stuff - COMMENT - - @parser.look_for_directives_in @top_level, comment - - section = @top_level.current_section - assert_equal 'new section', section.title - assert_equal [comment("# woo stuff\n", @top_level)], section.comments - - assert_empty comment - end - - def test_look_for_directives_in_unhandled - util_parser "" - - comment = RDoc::Comment.new "# :unhandled: blah\n", @top_level - - @parser.look_for_directives_in @top_level, comment - - assert_equal 'blah', @top_level.metadata['unhandled'] - end - - def test_parse_for_in - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new '', @top_level - - util_parser <<ruby -def sum(n) - result = 0 - for i in 1..n do - result += i - end - result -end -ruby - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - sum = klass.method_list.first - assert_equal 'sum', sum.name - assert_equal @top_level, sum.file - end - - def test_parse_on_ignored_nl_with_nil_text - util_parser <<ruby -class Foo - def meth - variable # comment - .chain - end -end -ruby - - expected = <<EXPECTED -<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">meth</span> - <span class="ruby-identifier">variable</span> <span class="ruby-comment"># comment</span> - .<span class="ruby-identifier">chain</span> -<span class="ruby-keyword">end</span> -EXPECTED - expected = expected.rstrip - - @parser.scan - - foo = @store.find_class_named 'Foo' - meth = foo.method_list.first - - assert_equal 'meth', meth.name - assert_equal @top_level, meth.file - - markup_code = meth.markup_code.sub(/^.*\n/, '') - assert_equal expected, markup_code - end - - def test_parse_redefined_op_with_constant - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new '', @top_level - - util_parser <<ruby -def meth - Integer::**() - return Integer::**() - break Integer::**() - case Integer::**() - when Integer::**() - end - while Integer::**() - end - yield Integer::**() - defined? Integer::**() - if Integer::**() - end -end -ruby - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - meth = klass.method_list.first - assert_equal 'meth', meth.name - end - - def test_parse_alias - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "alias :next= :bar" - - tk = @parser.get_tk - - alas = @parser.parse_alias klass, RDoc::Parser::Ruby::NORMAL, tk, 'comment' - - assert_equal 'bar', alas.old_name - assert_equal 'next=', alas.new_name - assert_equal klass, alas.parent - assert_equal 'comment', alas.comment - assert_equal @top_level, alas.file - assert_equal 1, alas.line - end - - def test_parse_alias_singleton - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "alias :next= :bar" - - tk = @parser.get_tk - - alas = @parser.parse_alias klass, RDoc::Parser::Ruby::SINGLE, tk, 'comment' - - assert_equal 'bar', alas.old_name - assert_equal 'next=', alas.new_name - assert_equal klass, alas.parent - assert_equal 'comment', alas.comment - assert_equal @top_level, alas.file - assert alas.singleton - end - - def test_parse_alias_stopdoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - klass.stop_doc - - util_parser "alias :next= :bar" - - tk = @parser.get_tk - - @parser.parse_alias klass, RDoc::Parser::Ruby::NORMAL, tk, 'comment' - - assert_empty klass.aliases - assert_empty klass.unmatched_alias_lists - end - - def test_parse_alias_meta - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "alias m.chop m" - - tk = @parser.get_tk - - alas = @parser.parse_alias klass, RDoc::Parser::Ruby::NORMAL, tk, 'comment' - - assert_nil alas - end - - def test_parse_attr - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my attr\n", @top_level, :ruby - - util_parser "attr :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_equal 1, klass.attributes.length - - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'my attr', foo.comment.text - assert_equal @top_level, foo.file - assert_equal 1, foo.line - end - - def test_parse_attr_stopdoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - klass.stop_doc - - comment = RDoc::Comment.new "##\n# my attr\n", @top_level - - util_parser "attr :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_empty klass.attributes - end - - def test_parse_attr_accessor - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my attr\n", @top_level, :ruby - - util_parser "attr_accessor :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_attr_accessor klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_equal 2, klass.attributes.length - - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'RW', foo.rw - assert_equal 'my attr', foo.comment.text - assert_equal @top_level, foo.file - assert_equal 1, foo.line - - bar = klass.attributes.last - assert_equal 'bar', bar.name - assert_equal 'RW', bar.rw - assert_equal 'my attr', bar.comment.text - end - - def test_parse_attr_accessor_with_newline - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my attr\n", @top_level, :ruby - - util_parser "attr_accessor :foo, :bar,\n :baz,\n :qux" - - tk = @parser.get_tk - - @parser.parse_attr_accessor klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_equal 4, klass.attributes.length - - foo = klass.attributes[0] - assert_equal 'foo', foo.name - assert_equal 'RW', foo.rw - assert_equal 'my attr', foo.comment.text - assert_equal @top_level, foo.file - assert_equal 1, foo.line - - bar = klass.attributes[1] - assert_equal 'bar', bar.name - assert_equal 'RW', bar.rw - assert_equal 'my attr', bar.comment.text - - bar = klass.attributes[2] - assert_equal 'baz', bar.name - assert_equal 'RW', bar.rw - assert_equal 'my attr', bar.comment.text - - bar = klass.attributes[3] - assert_equal 'qux', bar.name - assert_equal 'RW', bar.rw - assert_equal 'my attr', bar.comment.text - end - - def test_parse_attr_accessor_nodoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my attr\n", @top_level - - util_parser "attr_accessor :foo, :bar # :nodoc:" - - tk = @parser.get_tk - - @parser.parse_attr_accessor klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_equal 0, klass.attributes.length - end - - def test_parse_attr_accessor_nodoc_track - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my attr\n", @top_level - - @options.visibility = :nodoc - - util_parser "attr_accessor :foo, :bar # :nodoc:" - - tk = @parser.get_tk - - @parser.parse_attr_accessor klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - refute_empty klass.attributes - end - - def test_parse_attr_accessor_stopdoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - klass.stop_doc - - comment = RDoc::Comment.new "##\n# my attr\n", @top_level - - util_parser "attr_accessor :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_attr_accessor klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_empty klass.attributes - end - - def test_parse_attr_accessor_writer - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my attr\n", @top_level, :ruby - - util_parser "attr_writer :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_attr_accessor klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_equal 2, klass.attributes.length - - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'W', foo.rw - assert_equal "my attr", foo.comment.text - assert_equal @top_level, foo.file - - bar = klass.attributes.last - assert_equal 'bar', bar.name - assert_equal 'W', bar.rw - assert_equal "my attr", bar.comment.text - end - - def test_parse_meta_attr - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# :attr: \n# my method\n", @top_level, :ruby - - util_parser "add_my_method :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_equal 2, klass.attributes.length - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'RW', foo.rw - assert_equal "my method", foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_attr_accessor - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = - RDoc::Comment.new "##\n# :attr_accessor: \n# my method\n", @top_level, :ruby - - util_parser "add_my_method :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_equal 2, klass.attributes.length - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'RW', foo.rw - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_attr_named - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# :attr: foo\n# my method\n", @top_level, :ruby - - util_parser "add_my_method :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_equal 1, klass.attributes.length - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'RW', foo.rw - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_attr_reader - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = - RDoc::Comment.new "##\n# :attr_reader: \n# my method\n", @top_level, :ruby - - util_parser "add_my_method :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'R', foo.rw - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_attr_stopdoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - klass.stop_doc - - comment = RDoc::Comment.new "##\n# :attr: \n# my method\n", @top_level - - util_parser "add_my_method :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_empty klass.attributes - end - - def test_parse_meta_attr_writer - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = - RDoc::Comment.new "##\n# :attr_writer: \n# my method\n", @top_level, :ruby - - util_parser "add_my_method :foo, :bar" - - tk = @parser.get_tk - - @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'W', foo.rw - assert_equal "my method", foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_class - comment = RDoc::Comment.new "##\n# my class\n", @top_level, :ruby - - util_parser "class Foo\nend" - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - assert_equal 'my class', foo.comment.text - assert_equal [@top_level], foo.in_files - assert_equal 1, foo.line - end - - def test_parse_class_singleton - comment = RDoc::Comment.new "##\n# my class\n", @top_level - - util_parser <<-RUBY -class C - class << self - end -end - RUBY - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment - - c = @top_level.classes.first - assert_equal 'C', c.full_name - assert_equal 1, c.line - end - - def test_parse_class_ghost_method - util_parser <<-CLASS -class Foo - ## - # :method: blah - # my method -end - CLASS - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - assert_equal 'Foo#blah', blah.full_name - assert_equal 3, blah.line - assert_equal @top_level, blah.file - end - - def test_parse_class_in_a_file_repeatedly - @filename = 'a.rb' - comment_a = RDoc::Comment.new "# aaa\n", @top_level - util_parser "class Foo\nend" - tk = @parser.get_tk - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment_a - comment_b = RDoc::Comment.new "# bbb\n", @top_level - util_parser "class Foo\nend" - tk = @parser.get_tk - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment_b - - @filename = 'b.rb' - comment_c = RDoc::Comment.new "# ccc\n", @top_level - util_parser "class Foo\nend" - tk = @parser.get_tk - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment_c - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - assert_equal [[comment_a, @top_level], - [comment_b, @top_level], - [comment_c, @top_level]], foo.comment_location - assert_equal [@top_level], foo.in_files - assert_equal 1, foo.line - end - - def test_parse_class_ghost_method_yields - util_parser <<-CLASS -class Foo - ## - # :method: - # :call-seq: - # yields(name) -end - CLASS - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - assert_equal 'Foo#yields', blah.full_name - assert_equal 'yields(name)', blah.call_seq - assert_equal 3, blah.line - assert_equal @top_level, blah.file - end - - def test_parse_call_syntax_sugar_for_constant - util_parser <<-CODE -Foo = proc{} -Foo::() - CODE - - assert_nothing_raised do - @parser.scan - end - end - - def test_parse_class_multi_ghost_methods - util_parser <<-'CLASS' -class Foo - ## - # :method: one - # - # my method - - ## - # :method: two - # - # my method - - [:one, :two].each do |t| - eval("def #{t}; \"#{t}\"; end") - end -end - CLASS - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - assert_equal 2, foo.method_list.length - end - - def test_parse_class_nodoc - comment = RDoc::Comment.new "##\n# my class\n", @top_level - - util_parser "class Foo # :nodoc:\nend" - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - assert_empty foo.comment - assert_equal [@top_level], foo.in_files - assert_equal 1, foo.line - end - - def test_parse_class_single_root - comment = RDoc::Comment.new "##\n# my class\n", @top_level - - util_parser "class << ::Foo\nend" - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = @store.all_modules.first - assert_equal 'Foo', foo.full_name - end - - def test_parse_class_stopdoc - @top_level.stop_doc - - comment = RDoc::Comment.new "##\n# my class\n", @top_level - - util_parser "class Foo\nend" - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_empty @top_level.classes.first.comment - end - - def test_parse_class_lower_name_warning - @options.verbosity = 2 - stds = capture_output do - util_parser "class foo\nend" - tk = @parser.get_tk - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - end - err = stds[1] - assert_match(/Expected class name or '<<\'\. Got/, err) - end - - def test_parse_syntax_error_code - @options.verbosity = 2 - stds = capture_output do - begin - util_parser <<INVALID_CODE -# invalid class name -class Invalid::@@Code -end -INVALID_CODE - @parser.scan - rescue - end - end - err = stds[1] - - expected = <<EXPECTED -RDoc::Parser::Ruby failure around line 2 of -#{@filename} - -class Invalid::@@Code -EXPECTED - - assert_match(expected, err) - end - - def test_parse_multi_ghost_methods - util_parser <<-'CLASS' -class Foo - ## - # :method: one - # - # my method - - ## - # :method: two - # - # my method - - [:one, :two].each do |t| - eval("def #{t}; \"#{t}\"; end") - end -end - CLASS - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - assert_equal 2, foo.method_list.length - end - - def test_parse_const_fail_w_meta - util_parser <<-CLASS -class ConstFailMeta - ## - # :attr: one - # - # an attribute - - OtherModule.define_attr(self, :one) -end - CLASS - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - const_fail_meta = @top_level.classes.first - assert_equal 'ConstFailMeta', const_fail_meta.full_name - - assert_equal 1, const_fail_meta.attributes.length - end - - def test_parse_class_nested_superclass - foo = @top_level.add_module RDoc::NormalModule, 'Foo' - - util_parser "class Bar < Super\nend" - - tk = @parser.get_tk - - @parser.parse_class foo, RDoc::Parser::Ruby::NORMAL, tk, @comment - - bar = foo.classes.first - assert_equal 'Super', bar.superclass - end - - def test_parse_module - comment = RDoc::Comment.new "##\n# my module\n", @top_level, :ruby - - util_parser "module Foo\nend" - - tk = @parser.get_tk - - @parser.parse_module @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = @top_level.modules.first - assert_equal 'Foo', foo.full_name - assert_equal 'my module', foo.comment.text - end - - def test_parse_module_nodoc - @top_level.stop_doc - - comment = RDoc::Comment.new "##\n# my module\n", @top_level - - util_parser "module Foo # :nodoc:\nend" - - tk = @parser.get_tk - - @parser.parse_module @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = @top_level.modules.first - assert_equal 'Foo', foo.full_name - assert_empty foo.comment - end - - def test_parse_module_stopdoc - @top_level.stop_doc - - comment = RDoc::Comment.new "##\n# my module\n", @top_level - - util_parser "module Foo\nend" - - tk = @parser.get_tk - - @parser.parse_module @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = @top_level.modules.first - assert_equal 'Foo', foo.full_name - assert_empty foo.comment - end - - def test_parse_class_colon3 - code = <<-CODE -class A - class ::B - end -end - CODE - - util_parser code - - @parser.parse_class @top_level, false, @parser.get_tk, @comment - - assert_equal %w[A B], @store.all_classes.map { |c| c.full_name }.sort - end - - def test_parse_class_colon3_self_reference - code = <<-CODE -class A::B - class ::A - end -end - CODE - - util_parser code - - @parser.parse_class @top_level, false, @parser.get_tk, @comment - - assert_equal %w[A A::B], @store.all_classes.map { |c| c.full_name }.sort - end - - def test_parse_class_single - code = <<-CODE -class A - class << B - end - class << d = Object.new - def foo; end - alias bar foo - end -end - CODE - - util_parser code - - @parser.parse_class @top_level, false, @parser.get_tk, @comment - - assert_equal %w[A], @store.all_classes.map { |c| c.full_name } - - modules = @store.all_modules.sort_by { |c| c.full_name } - assert_equal %w[A::B A::d], modules.map { |c| c.full_name } - - b = modules.first - assert_equal 2, b.line - - # make sure method/alias was not added to enclosing class/module - a = @store.classes_hash['A'] - assert_empty a.method_list - - # make sure non-constant-named module will be removed from documentation - d = @store.modules_hash['A::d'] - assert d.remove_from_documentation? - end - - def test_parse_class_single_gvar - code = <<-CODE -class << $g - def m - end -end - CODE - - util_parser code - - @parser.parse_class @top_level, false, @parser.get_tk, '' - - assert_empty @store.all_classes - mod = @store.all_modules.first - - refute mod.document_self - - assert_empty mod.method_list - end - - # TODO this is really a Context#add_class test - def test_parse_class_object - code = <<-CODE -module A - class B - end - class Object - end - class C < Object - end -end - CODE - - util_parser code - - @parser.parse_module @top_level, false, @parser.get_tk, @comment - - assert_equal %w[A], - @store.all_modules.map { |c| c.full_name } - assert_equal %w[A::B A::C A::Object], - @store.all_classes.map { |c| c.full_name }.sort - - assert_equal 'Object', @store.classes_hash['A::B'].superclass - assert_equal 'Object', @store.classes_hash['A::Object'].superclass - assert_equal 'A::Object', @store.classes_hash['A::C'].superclass.full_name - end - - def test_parse_class_mistaken_for_module - # The code below is not strictly legal Ruby (Foo must have been defined - # before Foo::Bar is encountered), but RDoc might encounter Foo::Bar - # before Foo if they live in different files. - - code = <<-RUBY -class Foo::Bar -end - -module Foo::Baz -end - -class Foo -end - RUBY - - util_parser code - - @parser.scan - - assert_equal %w[Foo::Baz], @store.modules_hash.keys - assert_empty @top_level.modules - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - bar = foo.classes.first - assert_equal 'Foo::Bar', bar.full_name - - baz = foo.modules.first - assert_equal 'Foo::Baz', baz.full_name - end - - def test_parse_class_definition_encountered_after_class_reference - # The code below is not legal Ruby (Foo must have been defined before - # Foo.bar is encountered), but RDoc might encounter Foo.bar before Foo if - # they live in different files. - - code = <<-EOF -def Foo.bar -end - -class Foo < IO -end - EOF - - util_parser code - - @parser.scan - - assert_empty @store.modules_hash - assert_empty @store.all_modules - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - assert_equal 'IO', foo.superclass - - bar = foo.method_list.first - assert_equal 'bar', bar.name - end - - def test_parse_module_relative_to_top_level_namespace - comment = RDoc::Comment.new <<-EOF, @top_level -# -# Weirdly named module -# -EOF - - code = <<-EOF -#{comment.text} -module ::Foo - class Helper - end -end -EOF - - util_parser code - @parser.scan() - - foo = @top_level.modules.first - assert_equal 'Foo', foo.full_name - assert_equal 'Weirdly named module', foo.comment.text - - helper = foo.classes.first - assert_equal 'Foo::Helper', helper.full_name - end - - def test_parse_comment_attr - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# :attr: foo\n# my attr\n", @top_level, :ruby - - util_parser "\n" - - tk = @parser.get_tk - - @parser.parse_comment klass, tk, comment - - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'RW', foo.rw - assert_equal 'my attr', foo.comment.text - assert_equal @top_level, foo.file - assert_equal 1, foo.line - - assert_nil foo.viewer - assert_equal true, foo.document_children - assert_equal true, foo.document_self - assert_equal false, foo.done_documenting - assert_equal false, foo.force_documentation - assert_equal klass, foo.parent - assert_equal :public, foo.visibility - assert_equal "\n", foo.text - - assert_equal klass.current_section, foo.section - end - - def test_parse_comment_attr_attr_reader - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# :attr_reader: foo\n", @top_level - - util_parser "\n" - - tk = @parser.get_tk - - @parser.parse_comment klass, tk, comment - - foo = klass.attributes.first - assert_equal 'foo', foo.name - assert_equal 'R', foo.rw - end - - def test_parse_comment_attr_stopdoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - klass.stop_doc - - comment = RDoc::Comment.new "##\n# :attr: foo\n# my attr\n", @top_level - - util_parser "\n" - - tk = @parser.get_tk - - @parser.parse_comment klass, tk, comment - - assert_empty klass.attributes - end - - def test_parse_comment_method - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# :method: foo\n# my method\n", @top_level, :ruby - - util_parser "\n" - - tk = @parser.get_tk - - @parser.parse_comment klass, tk, comment - - foo = klass.method_list.first - assert_equal 'foo', foo.name - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - assert_equal 2, foo.line - - assert_equal [], foo.aliases - assert_nil foo.block_params - assert_nil foo.call_seq - assert_nil foo.is_alias_for - assert_nil foo.viewer - assert_equal true, foo.document_children - assert_equal true, foo.document_self - assert_equal '', foo.params - assert_equal false, foo.done_documenting - assert_equal false, foo.dont_rename_initialize - assert_equal false, foo.force_documentation - assert_equal klass, foo.parent - assert_equal false, foo.singleton - assert_equal :public, foo.visibility - assert_equal "\n", foo.text - assert_equal klass.current_section, foo.section - - stream = [ - { - :line_no => 2, :char_no => 1, :kind => :on_comment, - :text => "# File #{@top_level.relative_name}, line 2" - }, - { :line_no => 0, :char_no => 0, :kind => :on_nl, :text => "\n" }, - { :line_no => 1, :char_no => 1, :kind => :on_sp, :text => '' } - ] - parsed_stream = foo.token_stream.map { |t| - { - :line_no => t[:line_no], - :char_no => t[:char_no], - :kind => t[:kind], - :text => t[:text] - } - } - - assert_equal stream, parsed_stream - end - - def test_parse_comment_method_args - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - - util_parser "\n" - - tk = @parser.get_tk - - @parser.parse_comment klass, tk, - comment("##\n# :method: foo\n# :args: a, b\n") - - foo = klass.method_list.first - assert_equal 'foo', foo.name - assert_equal 'a, b', foo.params - end - - def test_parse_comment_method_stopdoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - klass.stop_doc - - comment = RDoc::Comment.new "##\n# :method: foo\n# my method\n", @top_level - - util_parser "\n" - - tk = @parser.get_tk - - @parser.parse_comment klass, tk, comment - - assert_empty klass.method_list - end - - def test_parse_constant - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "A = v" - - tk = @parser.get_tk - - @parser.parse_constant klass, tk, @comment - - foo = klass.constants.first - - assert_equal 'A', foo.name - assert_equal @top_level, foo.file - assert_equal 1, foo.line - end - - def test_parse_constant_attrasgn - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "A[k] = v" - - tk = @parser.get_tk - - @parser.parse_constant klass, tk, @comment - - assert klass.constants.empty? - end - - def test_parse_constant_alias - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - klass.add_class RDoc::NormalClass, 'B' - - util_parser "A = B" - - tk = @parser.get_tk - - @parser.parse_constant klass, tk, @comment - - assert_equal [], klass.modules.map(&:full_name) - assert_equal ['Foo::B', 'Foo::A'], klass.classes.map(&:full_name) - assert_equal ['Foo::A'], klass.constants.map(&:full_name) - assert_equal 'Foo::A', klass.find_module_named('A').full_name - end - - def test_parse_constant_alias_same_name - foo = @top_level.add_class RDoc::NormalClass, 'Foo' - @top_level.add_class RDoc::NormalClass, 'Bar' - bar = foo.add_class RDoc::NormalClass, 'Bar' - - assert @store.find_class_or_module('::Bar') - - util_parser "A = ::Bar" - - tk = @parser.get_tk - - @parser.parse_constant foo, tk, @comment - - assert_equal 'A', bar.find_module_named('A').full_name - end - - def test_parse_constant_in_method - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser 'A::B = v' - - tk = @parser.get_tk - - @parser.parse_constant klass, tk, @comment, true - - assert_empty klass.constants - - assert_empty @store.modules_hash.keys - assert_equal %w[Foo], @store.classes_hash.keys - end - - def test_parse_constant_rescue - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "A => e" - - tk = @parser.get_tk - - @parser.parse_constant klass, tk, @comment - - assert_empty klass.constants - assert_empty klass.modules - - assert_empty @store.modules_hash.keys - assert_equal %w[Foo], @store.classes_hash.keys - end - - def test_parse_constant_stopdoc - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - klass.stop_doc - - util_parser "A = v" - - tk = @parser.get_tk - - @parser.parse_constant klass, tk, @comment - - assert_empty klass.constants - end - - def test_parse_comment_nested - content = <<-CONTENT -A::B::C = 1 - CONTENT - - util_parser content - - tk = @parser.get_tk - - parsed = @parser.parse_constant @top_level, tk, 'comment' - - assert parsed - - a = @top_level.find_module_named 'A' - b = a.find_module_named 'B' - c = b.constants.first - - assert_equal 'A::B::C', c.full_name - assert_equal 'comment', c.comment - end - - def test_parse_class_the_same_of_outside - util_parser <<-RUBY -module A - class A::B - end -end - RUBY - - @parser.scan - - assert_includes @store.modules_hash, 'A' - module_a = @store.find_module_named 'A' - refute_empty module_a.classes_hash - assert_includes module_a.classes_hash, 'B' - refute_includes module_a.classes_hash, 'A' - end - - def test_parse_constant_the_same_of_outside - util_parser <<-RUBY -module A - class B - class C - end - end - - def self.foo - A::B::C - end -end - RUBY - - expected = <<EXPECTED -<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">foo</span> - <span class="ruby-constant">A</span><span class="ruby-operator">::</span><span class="ruby-constant">B</span><span class="ruby-operator">::</span><span class="ruby-constant">C</span> -<span class="ruby-keyword">end</span> -EXPECTED - expected = expected.rstrip - - @parser.scan - - module_a = @store.find_module_named 'A' - foo = module_a.method_list.first - markup_code = foo.markup_code.sub(/^.*\n/, '') - assert_equal expected, markup_code - end - - def test_parse_constant_with_bracket - util_parser <<-RUBY -class Klass -end - -class Klass2 - CONSTANT = Klass -end - -class Klass3 - CONSTANT_2 = {} - CONSTANT_2[1] = Klass -end - RUBY - - @parser.scan - - klass = @store.find_class_named 'Klass' - klass2 = @store.find_class_named 'Klass2' - klass3 = @store.find_class_named 'Klass3' - assert_equal klass, klass2.constants.first.is_alias_for - refute_equal klass, klass3.constants.first.is_alias_for - assert_nil klass3.find_module_named 'CONSTANT_2' - end - - def test_parse_extend_or_include_extend - klass = RDoc::NormalClass.new 'C' - klass.parent = @top_level - - comment = RDoc::Comment.new "# my extend\n", @top_level, :ruby - - util_parser "extend I" - - @parser.get_tk # extend - - @parser.parse_extend_or_include RDoc::Extend, klass, comment - - assert_equal 1, klass.extends.length - - ext = klass.extends.first - assert_equal 'I', ext.name - assert_equal 'my extend', ext.comment.text - assert_equal @top_level, ext.file - end - - def test_parse_extend_or_include_include - klass = RDoc::NormalClass.new 'C' - klass.parent = @top_level - - comment = RDoc::Comment.new "# my include\n", @top_level, :ruby - - util_parser "include I" - - @parser.get_tk # include - - @parser.parse_extend_or_include RDoc::Include, klass, comment - - assert_equal 1, klass.includes.length - - incl = klass.includes.first - assert_equal 'I', incl.name - assert_equal 'my include', incl.comment.text - assert_equal @top_level, incl.file - end - - def test_parse_meta_method - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my method\n", @top_level, :ruby - - util_parser "add_my_method :foo, :bar\nadd_my_method :baz" - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.method_list.first - assert_equal 'foo', foo.name - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - assert_equal 1, foo.line - - assert_equal [], foo.aliases - assert_nil foo.block_params - assert_nil foo.call_seq - assert_equal true, foo.document_children - assert_equal true, foo.document_self - assert_equal false, foo.done_documenting - assert_equal false, foo.dont_rename_initialize - assert_equal false, foo.force_documentation - assert_nil foo.is_alias_for - assert_equal '', foo.params - assert_equal klass, foo.parent - assert_equal false, foo.singleton - assert_equal 'add_my_method :foo', foo.text - assert_nil foo.viewer - assert_equal :public, foo.visibility - assert_equal klass.current_section, foo.section - - stream = [ - { - :line_no => 1, :char_no => 1, :kind => :on_comment, - :text => "# File #{@top_level.relative_name}, line 1" - }, - { :line_no => 0, :char_no => 0, :kind => :on_nl, :text => "\n" }, - { :line_no => 1, :char_no => 1, :kind => :on_sp, :text => '' }, - { :line_no => 1, :char_no => 0, :kind => :on_ident, :text => 'add_my_method' }, - { :line_no => 1, :char_no => 13, :kind => :on_sp, :text => ' ' }, - { :line_no => 1, :char_no => 14, :kind => :on_symbol, :text => ':foo' }, - { :line_no => 1, :char_no => 18, :kind => :on_comma, :text => ',' }, - { :line_no => 1, :char_no => 19, :kind => :on_sp, :text => ' ' }, - { :line_no => 1, :char_no => 20, :kind => :on_symbol, :text => ':bar' }, - { :line_no => 1, :char_no => 24, :kind => :on_nl, :text => "\n" } - ] - parsed_stream = foo.token_stream.map { |t| - { - :line_no => t[:line_no], - :char_no => t[:char_no], - :kind => t[:kind], - :text => t[:text] - } - } - - assert_equal stream, parsed_stream - end - - def test_parse_meta_method_block - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my method\n", @top_level - - content = <<-CONTENT -inline(:my_method) do |*args| - "this method causes z to disappear" -end - CONTENT - - util_parser content - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - rest = { :line_no => 3, :char_no => 3, :kind => :on_nl, :text => "\n" } - tk = @parser.get_tk - tk = { :line_no => tk[:line_no], :char_no => tk[:char_no], :kind => tk[:kind], :text => tk[:text] } - assert_equal rest, tk - end - - def test_parse_meta_method_define_method - klass = RDoc::NormalClass.new 'Foo' - comment = RDoc::Comment.new "##\n# my method\n", @top_level, :ruby - - util_parser "define_method :foo do end" - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.method_list.first - assert_equal 'foo', foo.name - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_method_name - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = - RDoc::Comment.new "##\n# :method: woo_hoo!\n# my method\n", @top_level, :ruby - - util_parser "add_my_method :foo, :bar\nadd_my_method :baz" - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.method_list.first - assert_equal 'woo_hoo!', foo.name - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_method_singleton - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = - RDoc::Comment.new "##\n# :singleton-method:\n# my method\n", @top_level, :ruby - - util_parser "add_my_method :foo, :bar\nadd_my_method :baz" - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.method_list.first - assert_equal 'foo', foo.name - assert_equal true, foo.singleton, 'singleton method' - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_method_singleton_name - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = - RDoc::Comment.new "##\n# :singleton-method: woo_hoo!\n# my method\n", - @top_level, :ruby - - util_parser "add_my_method :foo, :bar\nadd_my_method :baz" - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.method_list.first - assert_equal 'woo_hoo!', foo.name - assert_equal true, foo.singleton, 'singleton method' - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_method_string_name - klass = RDoc::NormalClass.new 'Foo' - comment = RDoc::Comment.new "##\n# my method\n", @top_level, :ruby - - util_parser "add_my_method 'foo'" - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.method_list.first - assert_equal 'foo', foo.name - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_meta_method_stopdoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - klass.stop_doc - - comment = RDoc::Comment.new "##\n# my method\n", @top_level - - util_parser "add_my_method :foo, :bar\nadd_my_method :baz" - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_empty klass.method_list - end - - def test_parse_meta_method_unknown - klass = RDoc::NormalClass.new 'Foo' - comment = RDoc::Comment.new "##\n# my method\n", @top_level, :ruby - - util_parser "add_my_method ('foo')" - - tk = @parser.get_tk - - @parser.parse_meta_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.method_list.first - assert_equal 'unknown', foo.name - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - end - - def test_parse_method - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "##\n# my method\n", @top_level, :ruby - - util_parser "def foo() :bar end" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - foo = klass.method_list.first - assert_equal 'foo', foo.name - assert_equal 'my method', foo.comment.text - assert_equal @top_level, foo.file - assert_equal 1, foo.line - - assert_equal [], foo.aliases - assert_nil foo.block_params - assert_nil foo.call_seq - assert_nil foo.is_alias_for - assert_nil foo.viewer - assert_equal true, foo.document_children - assert_equal true, foo.document_self - assert_equal '()', foo.params - assert_equal false, foo.done_documenting - assert_equal false, foo.dont_rename_initialize - assert_equal false, foo.force_documentation - assert_equal klass, foo.parent - assert_equal false, foo.singleton - assert_equal :public, foo.visibility - assert_equal 'def foo', foo.text - assert_equal klass.current_section, foo.section - - stream = [ - { - :line_no => 1, :char_no => 1, :kind => :on_comment, - :text => "# File #{@top_level.relative_name}, line 1" }, - { :line_no => 0, :char_no => 0, :kind => :on_nl, :text => "\n" }, - { :line_no => 1, :char_no => 1, :kind => :on_sp, :text => '' }, - { :line_no => 1, :char_no => 0, :kind => :on_kw, :text => 'def' }, - { :line_no => 1, :char_no => 3, :kind => :on_sp, :text => ' ' }, - { :line_no => 1, :char_no => 4, :kind => :on_ident, :text => 'foo' }, - { :line_no => 1, :char_no => 7, :kind => :on_lparen, :text => '(' }, - { :line_no => 1, :char_no => 8, :kind => :on_rparen, :text => ')' }, - { :line_no => 1, :char_no => 9, :kind => :on_sp, :text => ' ' }, - { :line_no => 1, :char_no => 10, :kind => :on_symbol, :text => ':bar' }, - { :line_no => 1, :char_no => 14, :kind => :on_sp, :text => ' ' }, - { :line_no => 1, :char_no => 15, :kind => :on_kw, :text => 'end' } - ] - parsed_stream = foo.token_stream.map { |t| - { - :line_no => t[:line_no], - :char_no => t[:char_no], - :kind => t[:kind], - :text => t[:text] - } - } - assert_equal stream, parsed_stream - end - - def test_parse_redefinable_methods - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - comment = RDoc::Comment.new "", @top_level - - redefinable_ops = %w[| ^ & <=> == === =~ > >= < <= << >> + - * / % ** ~ +@ -@ [] []= ` ! != !~] - redefinable_ops.each do |redefinable_op| - util_parser "def #{redefinable_op}\nend\n" - tk = @parser.get_tk - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - end - - klass.method_list.each do |method| - assert_equal :on_ident, method.token_stream[5][:kind] - assert_includes redefinable_ops, method.token_stream[5][:text] - end - end - - def test_parse_method_with_args_directive - util_parser <<-RUBY -class C - def meth_with_args_after # :args: a, b, c - end - - ## - # :args: d, e, f - def meth_with_args_before -end - RUBY - - @parser.scan - - c = @store.find_class_named 'C' - - assert_equal 'C#meth_with_args_after', c.method_list[0].full_name - assert_equal 'a, b, c', c.method_list[0].params - assert_equal 'C#meth_with_args_before', c.method_list[1].full_name - assert_equal 'd, e, f', c.method_list[1].params - end - - def test_parse_method_bracket - util_parser <<-RUBY -class C - def []; end - def self.[]; end - def []=; end - def self.[]=; end -end - RUBY - - @parser.scan - - c = @store.find_class_named 'C' - - assert_equal 4, c.method_list.size - assert_equal 'C#[]', c.method_list[0].full_name - assert_equal 'C::[]', c.method_list[1].full_name - assert_equal 'C#[]=', c.method_list[2].full_name - assert_equal 'C::[]=', c.method_list[3].full_name - assert c.aliases.empty? - end - - def test_parse_method_alias - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def m() alias a b; end" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - assert klass.aliases.empty? - end - - def test_parse_method_ampersand - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def self.&\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - ampersand = klass.method_list.first - assert_equal '&', ampersand.name - assert ampersand.singleton - end - - def test_parse_method_constant - c = RDoc::Constant.new 'CONST', nil, '' - m = @top_level.add_class RDoc::NormalModule, 'M' - m.add_constant c - - util_parser "def CONST.m() end" - - tk = @parser.get_tk - - @parser.parse_method m, RDoc::Parser::Ruby::NORMAL, tk, @comment - - assert_empty @store.modules_hash.keys - assert_equal %w[M], @store.classes_hash.keys - end - - def test_parse_method_false - util_parser "def false.foo() :bar end" - - tk = @parser.get_tk - - @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - klass = @store.find_class_named 'FalseClass' - - foo = klass.method_list.first - assert_equal 'foo', foo.name - end - - def test_parse_method_funky - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def (blah).foo() :bar end" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - assert_empty klass.method_list - end - - def test_parse_method_gvar - util_parser "def $stdout.foo() :bar end" - - tk = @parser.get_tk - - @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - assert @top_level.method_list.empty? - end - - def test_parse_method_gvar_insane - util_parser "def $stdout.foo() class << $other; end; end" - - tk = @parser.get_tk - - @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - assert @top_level.method_list.empty? - - assert_empty @store.all_classes - - assert_equal 1, @store.all_modules.length - - refute @store.all_modules.first.document_self - end - - def test_parse_method_internal_gvar - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo() def $blah.bar() end end" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - assert_equal 1, klass.method_list.length - end - - def test_parse_method_internal_ivar - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo() def @blah.bar() end end" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - assert_equal 1, klass.method_list.length - end - - def test_parse_method_internal_lvar - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo() def blah.bar() end end" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - assert_equal 1, klass.method_list.length - end - - def test_parse_method_nil - util_parser "def nil.foo() :bar end" - - tk = @parser.get_tk - - @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - klass = @store.find_class_named 'NilClass' - - foo = klass.method_list.first - assert_equal 'foo', foo.name - end - - def test_parse_method_nodoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo # :nodoc:\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment('') - - assert_empty klass.method_list - end - - def test_parse_method_nodoc_track - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - @options.visibility = :nodoc - - util_parser "def foo # :nodoc:\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment('') - - refute_empty klass.method_list - end - - def test_parse_method_no_parens - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo arg1, arg2 = {}\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = klass.method_list.first - assert_equal '(arg1, arg2 = {})', foo.params - assert_equal @top_level, foo.file - end - - def test_parse_method_parameters_comment - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo arg1, arg2 # some useful comment\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = klass.method_list.first - assert_equal '(arg1, arg2)', foo.params - end - - def test_parse_method_parameters_comment_continue - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo arg1, arg2, # some useful comment\narg3\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = klass.method_list.first - assert_equal '(arg1, arg2, arg3)', foo.params - end - - def test_parse_method_parameters_with_paren_comment_continue - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo(arg1, arg2, # some useful comment\narg3)\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = klass.method_list.first - assert_equal '(arg1, arg2, arg3)', foo.params - end - - def test_parse_method_star - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def self.*\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - ampersand = klass.method_list.first - assert_equal '*', ampersand.name - assert ampersand.singleton - end - - def test_parse_method_stopdoc - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - klass.stop_doc - - comment = RDoc::Comment.new "##\n# my method\n", @top_level - - util_parser "def foo() :bar end" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment - - assert_empty klass.method_list - end - - def test_parse_method_toplevel - klass = @top_level - - util_parser "def foo arg1, arg2\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - object = @store.find_class_named 'Object' - - foo = object.method_list.first - assert_equal 'Object#foo', foo.full_name - assert_equal @top_level, foo.file - end - - def test_parse_method_toplevel_class - klass = @top_level - - util_parser "def Object.foo arg1, arg2\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - object = @store.find_class_named 'Object' - - foo = object.method_list.first - assert_equal 'Object::foo', foo.full_name - end - - def test_parse_method_true - util_parser "def true.foo() :bar end" - - tk = @parser.get_tk - - @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - klass = @store.find_class_named 'TrueClass' - - foo = klass.method_list.first - assert_equal 'foo', foo.name - end - - def test_parse_method_utf8 - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - method = "def ω() end" - - assert_equal Encoding::UTF_8, method.encoding - - util_parser method - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - omega = klass.method_list.first - assert_equal "def \317\211", omega.text - end - - def test_parse_method_dummy - util_parser ".method() end" - - @parser.parse_method_dummy @top_level - - assert_nil @parser.get_tk - end - - def test_parse_method_or_yield_parameters_hash - util_parser "({})\n" - - m = RDoc::AnyMethod.new nil, 'm' - - result = @parser.parse_method_or_yield_parameters m - - assert_equal '({})', result - end - - def test_parse_statements_class_if - util_parser <<-CODE -module Foo - X = if TRUE then - '' - end - - def blah - end -end - CODE - - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil - - foo = @top_level.modules.first - assert_equal 'Foo', foo.full_name, 'module Foo' - - methods = foo.method_list - assert_equal 1, methods.length - assert_equal 'Foo#blah', methods.first.full_name - end - - def test_parse_statements_postfix_if_unless - util_parser <<-CODE -class C - def foo - 1 if nil - end - - def bar - 2 unless nil - end -end - CODE - - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil - - c = @top_level.classes.first - assert_equal 'C', c.full_name, 'class C' - - methods = c.method_list - assert_equal 2, methods.length - assert_equal 'C#foo', methods[0].full_name - assert_equal 'C#bar', methods[1].full_name - end - - def test_parse_statements_postfix_if_unless_with_expr_mid - util_parser <<-CODE -class A - class B - def foo - return if nil - end - end - - class C - end -end - CODE - - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil - - a = @top_level.classes.first - assert_equal 'A', a.full_name, 'class A' - assert_equal 2, a.classes.length - b = a.classes[0] - assert_equal 'A::B', b.full_name, 'class A::B' - c = a.classes[1] - assert_equal 'A::C', c.full_name, 'class A::C' - end - - def test_parse_statements_class_nested - comment = RDoc::Comment.new "##\n# my method\n", @top_level - - util_parser "module Foo\n#{comment.text}class Bar\nend\nend" - - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL - - foo = @top_level.modules.first - assert_equal 'Foo', foo.full_name, 'module Foo' - - bar = foo.classes.first - assert_equal 'Foo::Bar', bar.full_name, 'class Foo::Bar' - assert_equal 'my method', bar.comment.text - end - - def test_parse_statements_def_percent_string_pound - util_parser "class C\ndef a\n%r{#}\n%r{\#{}}\nend\ndef b() end\nend" - - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL - - x = @top_level.classes.first - - assert_equal 2, x.method_list.length - a = x.method_list.first - - - expected = [ - { - :line_no => 2, :char_no => 1, :kind => :on_comment, - :text => "# File #{@filename}, line 2" - }, - { :line_no => 0, :char_no => 0, :kind => :on_nl, :text => "\n" }, - { :line_no => 1, :char_no => 1, :kind => :on_sp, :text => '' }, - { :line_no => 2, :char_no => 0, :kind => :on_kw, :text => 'def' }, - { :line_no => 2, :char_no => 3, :kind => :on_sp, :text => ' ' }, - { :line_no => 2, :char_no => 4, :kind => :on_ident, :text => 'a' }, - { :line_no => 2, :char_no => 5, :kind => :on_nl, :text => "\n" }, - { :line_no => 3, :char_no => 0, :kind => :on_regexp, :text => '%r{#}' }, - { :line_no => 3, :char_no => 5, :kind => :on_nl, :text => "\n" }, - { :line_no => 4, :char_no => 0, :kind => :on_regexp, :text => '%r{#{}}' }, - { :line_no => 4, :char_no => 7, :kind => :on_nl, :text => "\n" }, - { :line_no => 5, :char_no => 0, :kind => :on_kw, :text => 'end' } - ] - parsed_stream = a.token_stream.map { |tk| - { - :line_no => tk[:line_no], - :char_no => tk[:char_no], - :kind => tk[:kind], - :text => tk[:text] - } - } - - assert_equal expected, parsed_stream - end - - def test_parse_statements_encoding - @options.encoding = Encoding::CP852 - - content = <<-EOF -class Foo - ## - # this is my method - add_my_method :foo -end - EOF - - util_parser content - - @parser.parse_statements @top_level - - foo = @top_level.classes.first.method_list.first - assert_equal 'foo', foo.name - assert_equal 'this is my method', foo.comment.text - assert_equal Encoding::CP852, foo.comment.text.encoding - end - - def test_parse_statements_enddoc - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "\n# :enddoc:" - - @parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil - - assert klass.done_documenting - end - - def test_parse_statements_enddoc_top_level - util_parser "\n# :enddoc:" - - assert_throws :eof do - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil - end - end - - def test_parse_statements_identifier_meta_method - content = <<-EOF -class Foo - ## - # this is my method - add_my_method :foo -end - EOF - - util_parser content - - @parser.parse_statements @top_level - - foo = @top_level.classes.first.method_list.first - assert_equal 'foo', foo.name - end - - def test_parse_statements_identifier_alias_method - content = <<-RUBY -class Foo - def foo() end - alias_method :foo2, :foo -end - RUBY - - util_parser content - - @parser.parse_statements @top_level - - foo = @top_level.classes.first.method_list[0] - assert_equal 'foo', foo.name - - foo2 = @top_level.classes.first.method_list.last - assert_equal 'foo2', foo2.name - assert_equal 'foo', foo2.is_alias_for.name - assert @top_level.classes.first.aliases.empty? - end - - def test_parse_statements_identifier_alias_method_before_original_method - # This is not strictly legal Ruby code, but it simulates finding an alias - # for a method before finding the original method, which might happen - # to rdoc if the alias is in a different file than the original method - # and rdoc processes the alias' file first. - content = <<-EOF -class Foo - alias_method :foo2, :foo - - alias_method :foo3, :foo - - def foo() - end - - alias_method :foo4, :foo - - alias_method :foo5, :unknown -end -EOF - - util_parser content - - @parser.parse_statements @top_level - - foo = @top_level.classes.first.method_list[0] - assert_equal 'foo', foo.name - - foo2 = @top_level.classes.first.method_list[1] - assert_equal 'foo2', foo2.name - assert_equal 'foo', foo2.is_alias_for.name - - foo3 = @top_level.classes.first.method_list[2] - assert_equal 'foo3', foo3.name - assert_equal 'foo', foo3.is_alias_for.name - - foo4 = @top_level.classes.first.method_list.last - assert_equal 'foo4', foo4.name - assert_equal 'foo', foo4.is_alias_for.name - - assert_equal 'unknown', @top_level.classes.first.external_aliases[0].old_name - end - - def test_parse_statements_identifier_args - comment = "##\n# :args: x\n# :method: b\n# my method\n" - - util_parser "module M\n#{comment}def_delegator :a, :b, :b\nend" - - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL - - m = @top_level.modules.first - assert_equal 'M', m.full_name - - b = m.method_list.first - assert_equal 'M#b', b.full_name - assert_equal 'x', b.params - assert_equal 'my method', b.comment.text - - assert_nil m.params, 'Module parameter not removed' - end - - def test_parse_statements_identifier_constant - sixth_constant = <<-EOF -Class.new do - rule :file do - all(x, y, z) { - def value - find(:require).each {|r| require r.value } - find(:grammar).map {|g| g.value } - end - def min; end - } - end -end - EOF - - content = <<-EOF -class Foo - FIRST_CONSTANT = 5 - - SECOND_CONSTANT = [ - 1, - 2, - 3 - ] - - THIRD_CONSTANT = { - :foo => 'bar', - :x => 'y' - } - - FOURTH_CONSTANT = SECOND_CONSTANT.map do |element| - element + 1 - element + 2 - end - - FIFTH_CONSTANT = SECOND_CONSTANT.map { |element| element + 1 } - - SIXTH_CONSTANT = #{sixth_constant} - - SEVENTH_CONSTANT = proc { |i| begin i end } - - EIGHTH_CONSTANT = "a" \\ - "b" -end -EOF - - util_parser content - - @parser.parse_statements @top_level - - constants = @top_level.classes.first.constants - - constant = constants[0] - assert_equal 'FIRST_CONSTANT', constant.name - assert_equal '5', constant.value - assert_equal @top_level, constant.file - - constant = constants[1] - assert_equal 'SECOND_CONSTANT', constant.name - assert_equal "[\n1,\n2,\n3\n]", constant.value - assert_equal @top_level, constant.file - - constant = constants[2] - assert_equal 'THIRD_CONSTANT', constant.name - assert_equal "{\n:foo => 'bar',\n:x => 'y'\n}", constant.value - assert_equal @top_level, constant.file - - constant = constants[3] - assert_equal 'FOURTH_CONSTANT', constant.name - assert_equal "SECOND_CONSTANT.map do |element|\nelement + 1\nelement + 2\nend", constant.value - assert_equal @top_level, constant.file - - constant = constants[4] - assert_equal 'FIFTH_CONSTANT', constant.name - assert_equal 'SECOND_CONSTANT.map { |element| element + 1 }', constant.value - assert_equal @top_level, constant.file - - # TODO: parse as class - constant = constants[5] - assert_equal 'SIXTH_CONSTANT', constant.name - assert_equal sixth_constant.lines.map(&:strip).join("\n"), constant.value - assert_equal @top_level, constant.file - - # TODO: parse as method - constant = constants[6] - assert_equal 'SEVENTH_CONSTANT', constant.name - assert_equal "proc { |i| begin i end }", constant.value - assert_equal @top_level, constant.file - - constant = constants[7] - assert_equal 'EIGHTH_CONSTANT', constant.name - assert_equal "\"a\" \\\n\"b\"", constant.value - assert_equal @top_level, constant.file - end - - def test_parse_statements_identifier_attr - content = "class Foo\nattr :foo\nend" - - util_parser content - - @parser.parse_statements @top_level - - foo = @top_level.classes.first.attributes.first - assert_equal 'foo', foo.name - assert_equal 'R', foo.rw - end - - def test_parse_statements_identifier_attr_accessor - content = "class Foo\nattr_accessor :foo\nend" - - util_parser content - - @parser.parse_statements @top_level - - foo = @top_level.classes.first.attributes.first - assert_equal 'foo', foo.name - assert_equal 'RW', foo.rw - end - - def test_parse_statements_identifier_define_method - util_parser <<-RUBY -class C - ## - # :method: a - define_method :a do end - ## - # :method: b - define_method :b do end -end - RUBY - - @parser.parse_statements @top_level - c = @top_level.classes.first - - assert_equal %w[a b], c.method_list.map { |m| m.name } - end - - def test_parse_statements_identifier_include - content = "class Foo\ninclude Bar\nend" - - util_parser content - - @parser.parse_statements @top_level - - foo = @top_level.classes.first - assert_equal 'Foo', foo.name - assert_equal 1, foo.includes.length - end - - def test_parse_statements_identifier_module_function - content = "module Foo\ndef foo() end\nmodule_function :foo\nend" - - util_parser content - - @parser.parse_statements @top_level - - foo, s_foo = @top_level.modules.first.method_list - assert_equal 'foo', foo.name, 'instance method name' - assert_equal :private, foo.visibility, 'instance method visibility' - assert_equal false, foo.singleton, 'instance method singleton' - - assert_equal 'foo', s_foo.name, 'module function name' - assert_equal :public, s_foo.visibility, 'module function visibility' - assert_equal true, s_foo.singleton, 'module function singleton' - end - - def test_parse_statements_identifier_private - content = "class Foo\nprivate\ndef foo() end\nend" - - util_parser content - - @parser.parse_statements @top_level - - foo = @top_level.classes.first.method_list.first - assert_equal 'foo', foo.name - assert_equal :private, foo.visibility - end - - def test_parse_statements_identifier_public_class_method - content = <<-CONTENT -class Date - def self.now; end - private_class_method :now -end - -class DateTime < Date - public_class_method :now -end - CONTENT - - util_parser content - - @parser.parse_statements @top_level - - date, date_time = @top_level.classes.sort_by { |c| c.full_name } - - date_now = date.method_list.first - date_time_now = date_time.method_list.sort_by { |m| m.full_name }.first - - assert_equal :private, date_now.visibility - assert_equal :public, date_time_now.visibility - end - - def test_parse_statements_identifier_private_class_method - content = <<-CONTENT -class Date - def self.now; end - public_class_method :now -end - -class DateTime < Date - private_class_method :now -end - CONTENT - - util_parser content - - @parser.parse_statements @top_level - - # TODO sort classes by default - date, date_time = @top_level.classes.sort_by { |c| c.full_name } - - date_now = date.method_list.first - date_time_now = date_time.method_list.sort_by { |m| m.full_name }.first - - assert_equal :public, date_now.visibility, date_now.full_name - assert_equal :private, date_time_now.visibility, date_time_now.full_name - end - - def test_parse_statements_complex_condition_in_for - util_parser <<RUBY -class Foo - def blah() - for i in (k)...n do - end - for i in (k)...n - end - end -end -RUBY - - expected = <<EXPECTED -<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">blah</span>() - <span class="ruby-keyword">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">in</span> (<span class="ruby-identifier">k</span>)<span class="ruby-operator">...</span><span class="ruby-identifier">n</span> <span class="ruby-keyword">do</span> - <span class="ruby-keyword">end</span> - <span class="ruby-keyword">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">in</span> (<span class="ruby-identifier">k</span>)<span class="ruby-operator">...</span><span class="ruby-identifier">n</span> - <span class="ruby-keyword">end</span> -<span class="ruby-keyword">end</span> -EXPECTED - expected = expected.rstrip - - @parser.scan - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - markup_code = blah.markup_code.sub(/^.*\n/, '') - assert_equal expected, markup_code - end - - def test_parse_instance_operation_method - util_parser <<-RUBY -class Foo - def self.& end -end - RUBY - - expected = <<EXPECTED - <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">&</span> <span class="ruby-keyword">end</span> -<span class="ruby-keyword">end</span> -EXPECTED - expected = expected.rstrip - - @parser.scan - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - markup_code = blah.markup_code.sub(/^.*\n/, '') - assert_equal expected, markup_code - end - - def test_parse_statements_postfix_if_after_heredocbeg - @filename = 'file.rb' - util_parser <<RUBY -class Foo - def blah() - <<-EOM if true - EOM - end -end -RUBY - - expected = <<EXPECTED - <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">blah</span>() - <span class="ruby-identifier"><<-EOM</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">true</span> -<span class="ruby-value"></span><span class="ruby-identifier"> EOM</span> - <span class="ruby-keyword">end</span> -EXPECTED - expected = expected.rstrip - - @parser.scan - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - markup_code = blah.markup_code.sub(/^.*\n/, '') - assert_equal expected, markup_code - end - - def test_parse_mutable_heredocbeg - @filename = 'file.rb' - util_parser <<RUBY -class Foo - def blah() - @str = -<<-EOM - EOM - end -end -RUBY - - expected = <<EXPECTED - <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">blah</span>() - <span class="ruby-ivar">@str</span> = <span class="ruby-identifier">-<<-EOM</span> -<span class="ruby-value"></span><span class="ruby-identifier"> EOM</span> - <span class="ruby-keyword">end</span> -EXPECTED - expected = expected.rstrip - - @parser.scan - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - markup_code = blah.markup_code.sub(/^.*\n/, '') - assert_equal expected, markup_code - end - - def test_parse_heredoc_end - code = "A = <<eos\n""OK\n""eos\n" - util_parser code - @parser.parse_statements @top_level - @parser.scan - c = @top_level.classes.first.constants.first - assert_equal("A", c.name) - - util_parser code.gsub(/$/, "\r") - @parser.parse_statements @top_level - @parser.scan - c = @top_level.classes.first.constants.first - assert_equal("A", c.name) - end - - def test_parse_statements_method_oneliner_with_regexp - util_parser <<RUBY -class Foo - def blah() /bar/ end -end -RUBY - - expected = <<EXPECTED -<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">blah</span>() <span class="ruby-regexp">/bar/</span> <span class="ruby-keyword">end</span> -EXPECTED - expected = expected.rstrip - - @parser.scan - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - markup_code = blah.markup_code.sub(/^.*\n/, '') - assert_equal expected, markup_code - end - - def test_parse_statements_embdoc_in_document - @filename = 'file.rb' - util_parser <<RUBY -class Foo - # doc - # - # =begin - # test embdoc - # =end - # - def blah - end -end -RUBY - - expected = <<EXPECTED -<p>doc - -<pre class="ruby"><span class="ruby-comment">=begin -test embdoc -=end</span> -</pre> -EXPECTED - - @parser.scan - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - markup_comment = blah.search_record[6] - assert_equal expected, markup_comment - end - - def test_parse_require_dynamic_string - content = <<-RUBY -prefix = 'path' -require "\#{prefix}/a_library" -require 'test' -RUBY - - util_parser content - - @parser.parse_statements @top_level - - assert_equal 1, @top_level.requires.length - end - - def test_parse_postfix_nodoc - util_parser <<-RUBY -class A -end # :nodoc: - -class B - def a - end # :nodoc: - - def b - end -end -RUBY - - @parser.parse_statements @top_level - - c_a = @top_level.classes.select(&:document_self).first - assert_equal 'B', c_a.full_name - - assert_equal 2, @top_level.classes.length - assert_equal 1, @top_level.classes.count(&:document_self) - assert_equal 1, c_a.method_list.length - assert_equal 'B#b', c_a.method_list.first.full_name - end - - def test_parse_statements_identifier_require - content = "require 'bar'" - - util_parser content - - @parser.parse_statements @top_level - - assert_equal 1, @top_level.requires.length - end - - def test_parse_statements_identifier_yields - comment = "##\n# :yields: x\n# :method: b\n# my method\n" - - util_parser "module M\n#{comment}def_delegator :a, :b, :b\nend" - - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL - - m = @top_level.modules.first - assert_equal 'M', m.full_name - - b = m.method_list.first - assert_equal 'M#b', b.full_name - assert_equal 'x', b.block_params - assert_equal 'my method', b.comment.text - - assert_nil m.params, 'Module parameter not removed' - end - - def test_parse_statements_nodoc_identifier_alias - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "\nalias :old :new # :nodoc:" - - @parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil - - assert_empty klass.aliases - assert_empty klass.unmatched_alias_lists - end - - def test_parse_statements_nodoc_identifier_alias_method - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "\nalias_method :old :new # :nodoc:" - - @parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil - - assert_empty klass.aliases - assert_empty klass.unmatched_alias_lists - end - - def test_parse_statements_stopdoc_alias - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "\n# :stopdoc:\nalias old new" - - @parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil - - assert_empty klass.aliases - assert_empty klass.unmatched_alias_lists - end - - def test_parse_statements_stopdoc_identifier_alias_method - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "\n# :stopdoc:\nalias_method :old :new" - - @parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil - - assert_empty klass.aliases - assert_empty klass.unmatched_alias_lists - end - - def test_parse_statements_stopdoc_identifier_metaprogrammed - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "\n# :stopdoc:\n# attr :meta" - - @parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil - - assert_empty klass.method_list - assert_empty klass.attributes - end - - def test_parse_statements_stopdoc_constant - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "\n# :stopdoc:\nA = v" - - @parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil - - assert_empty klass.constants - end - - def test_parse_statements_stopdoc_def - klass = @top_level.add_class RDoc::NormalClass, 'Foo' - - util_parser "\n# :stopdoc:\ndef m\n end" - - @parser.parse_statements klass, RDoc::Parser::Ruby::NORMAL, nil - - assert_empty klass.method_list - end - - def test_parse_statements_super - m = RDoc::AnyMethod.new '', 'm' - util_parser 'super' - - @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, m - - assert m.calls_super - end - - def test_parse_statements_super_no_method - content = "super" - - util_parser content - - @parser.parse_statements @top_level - - assert_nil @parser.get_tk - end - - def test_parse_statements_while_begin - util_parser <<-RUBY -class A - def a - while begin a; b end - end - end - - def b - end -end - RUBY - - @parser.parse_statements @top_level - - c_a = @top_level.classes.first - assert_equal 'A', c_a.full_name - - assert_equal 1, @top_level.classes.length - - m_a = c_a.method_list.first - m_b = c_a.method_list.last - - assert_equal 'A#a', m_a.full_name - assert_equal 'A#b', m_b.full_name - end - - - def test_parse_symbol_in_paren_arg - util_parser <<RUBY -class Foo - def blah - end - private(:blah) -end -RUBY - - @parser.scan - - foo = @top_level.classes.first - assert_equal 'Foo', foo.full_name - - blah = foo.method_list.first - assert_equal :private, blah.visibility - end - - def test_parse_symbol_in_arg - util_parser '[:blah, "blah", "#{blah}", blah]' - @parser.get_tk # skip '[' - - assert_equal 'blah', @parser.parse_symbol_in_arg - @parser.get_tk # skip ',' - - @parser.skip_tkspace - - assert_equal 'blah', @parser.parse_symbol_in_arg - @parser.get_tk # skip ',' - - @parser.skip_tkspace - - assert_nil @parser.parse_symbol_in_arg - @parser.get_tk # skip ',' - - @parser.skip_tkspace - - assert_nil @parser.parse_symbol_in_arg - end - - def test_parse_percent_symbol - content = '%s[foo bar]' - util_parser content - tk = @parser.get_tk - assert_equal :on_symbol, tk[:kind] - assert_equal content, tk[:text] - end - - def test_parse_statements_alias_method - content = <<-CONTENT -class A - alias_method :a, :[] unless c -end - -B = A - -class C -end - CONTENT - - util_parser content - - @parser.parse_statements @top_level - - # HACK where are the assertions? - end - - def test_parse_top_level_statements_enddoc - util_parser <<-CONTENT -# :enddoc: - CONTENT - - assert_throws :eof do - @parser.parse_top_level_statements @top_level - end - end - - def test_parse_top_level_statements_stopdoc - @top_level.stop_doc - content = "# this is the top-level comment" - - util_parser content - - @parser.parse_top_level_statements @top_level - - assert_empty @top_level.comment - end - - def test_parse_top_level_statements_stopdoc_integration - content = <<-CONTENT -# :stopdoc: - -class Example - def method_name - end -end - CONTENT - - util_parser content - - @parser.parse_top_level_statements @top_level - - assert_equal 1, @top_level.classes.length - assert_empty @top_level.modules - - assert @top_level.find_module_named('Example').ignored? - end - - # This tests parse_comment - def test_parse_top_level_statements_constant_nodoc_integration - content = <<-CONTENT -class A - C = A # :nodoc: -end - CONTENT - - util_parser content - - @parser.parse_top_level_statements @top_level - - klass = @top_level.find_module_named('A') - - c = klass.constants.first - - assert_nil c.document_self, 'C should not be documented' - end - - def test_parse_yield_in_braces_with_parens - klass = RDoc::NormalClass.new 'Foo' - klass.parent = @top_level - - util_parser "def foo\nn.times { |i| yield nth(i) }\nend" - - tk = @parser.get_tk - - @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment - - foo = klass.method_list.first - assert_equal 'nth(i)', foo.block_params - end - - def test_read_directive - parser = util_parser '# :category: test' - - directive, value = parser.read_directive %w[category] - - assert_equal 'category', directive - assert_equal 'test', value - - assert_nil parser.get_tk - end - - def test_read_directive_allow - parser = util_parser '# :category: test' - - directive = parser.read_directive [] - - assert_nil directive - - assert_nil parser.get_tk - end - - def test_read_directive_empty - parser = util_parser '# test' - - directive = parser.read_directive %w[category] - - assert_nil directive - - assert_nil parser.get_tk - end - - def test_read_directive_no_comment - parser = util_parser '' - - directive = parser.read_directive %w[category] - - assert_nil directive - - assert_nil parser.get_tk - end - - def test_read_directive_one_liner - parser = util_parser 'AAA = 1 # :category: test' - - directive, value = parser.read_directive %w[category] - - assert_equal 'category', directive - assert_equal 'test', value - - assert_equal :on_const, parser.get_tk[:kind] - end - - def test_read_directive_linear_performance - pre = ->(i) {util_parser '# ' + '0'*i + '=000:'} - assert_linear_performance((1..5).map{|i|10**i}, pre: pre) do |parser| - assert_nil parser.read_directive [] - end - end - - def test_read_documentation_modifiers - c = RDoc::Context.new - - parser = util_parser '# :category: test' - - parser.read_documentation_modifiers c, %w[category] - - assert_equal 'test', c.current_section.title - end - - def test_read_documentation_modifiers_notnew - m = RDoc::AnyMethod.new nil, 'initialize' - - parser = util_parser '# :notnew: test' - - parser.read_documentation_modifiers m, %w[notnew] - - assert m.dont_rename_initialize - end - - def test_read_documentation_modifiers_not_dash_new - m = RDoc::AnyMethod.new nil, 'initialize' - - parser = util_parser '# :not-new: test' - - parser.read_documentation_modifiers m, %w[not-new] - - assert m.dont_rename_initialize - end - - def test_read_documentation_modifiers_not_new - m = RDoc::AnyMethod.new nil, 'initialize' - - parser = util_parser '# :not_new: test' - - parser.read_documentation_modifiers m, %w[not_new] - - assert m.dont_rename_initialize - end - - def test_sanity_integer - util_parser '1' - assert_equal '1', @parser.get_tk[:text] - - util_parser '1.0' - assert_equal '1.0', @parser.get_tk[:text] - end - - def test_sanity_interpolation - last_tk = nil - util_parser 'class A; B = "#{c}"; end' - - while tk = @parser.get_tk do last_tk = tk end - - assert_equal 'end', last_tk[:text] - end - - # If you're writing code like this you're doing it wrong - - def test_sanity_interpolation_crazy - util_parser '"#{"#{"a")}" if b}"' - - assert_equal '"#{"#{"a")}" if b}"', @parser.get_tk[:text] - assert_nil @parser.get_tk - end - - def test_sanity_interpolation_curly - util_parser '%{ #{} }' - - assert_equal '%{ #{} }', @parser.get_tk[:text] - assert_nil @parser.get_tk - end - - def test_sanity_interpolation_format - util_parser '"#{stftime("%m-%d")}"' - - while @parser.get_tk do end - end - - def test_sanity_symbol_interpolation - util_parser ':"#{bar}="' - - while @parser.get_tk do end - end - - def test_scan_cr - content = <<-CONTENT -class C\r - def m\r - a=\\\r - 123\r - end\r -end\r - CONTENT - - util_parser content - - @parser.scan - - c = @top_level.classes.first - - assert_equal 1, c.method_list.length - end - - def test_scan_block_comment - content = <<-CONTENT -=begin rdoc -Foo comment -=end - -class Foo - -=begin -m comment -=end - - def m() end -end - CONTENT - - util_parser content - - @parser.scan - - foo = @top_level.classes.first - - assert_equal 'Foo comment', foo.comment.text - - m = foo.method_list.first - - assert_equal 'm comment', m.comment.text - end - - def test_scan_block_comment_nested # Issue #41 - content = <<-CONTENT -require 'something' -=begin rdoc -findmeindoc -=end -module Foo - class Bar - end -end - CONTENT - - util_parser content - - @parser.scan - - foo = @top_level.modules.first - - assert_equal 'Foo', foo.full_name - assert_equal 'findmeindoc', foo.comment.text - - bar = foo.classes.first - - assert_equal 'Foo::Bar', bar.full_name - assert_equal '', bar.comment.text - end - - def test_scan_block_comment_notflush - ## - # - # The previous test assumes that between the =begin/=end blocks that there - # is only one line, or minima formatting directives. This test tests for - # those who use the =begin block with longer / more advanced formatting - # within. - # - ## - content = <<-CONTENT -=begin rdoc - -= DESCRIPTION - -This is a simple test class - -= RUMPUS - -Is a silly word - -=end -class StevenSimpleClass - # A band on my iPhone as I wrote this test - FRUIT_BATS="Make nice music" - -=begin rdoc -A nice girl -=end - - def lauren - puts "Summoning Lauren!" - end -end - CONTENT - util_parser content - - @parser.scan - - foo = @top_level.classes.first - - assert_equal "= DESCRIPTION\n\nThis is a simple test class\n\n= RUMPUS\n\nIs a silly word", - foo.comment.text - - m = foo.method_list.first - - assert_equal 'A nice girl', m.comment.text - end - - def test_scan_class_nested_nodoc - content = <<-CONTENT -class A::B # :nodoc: -end - CONTENT - - util_parser content - - @parser.scan - - visible = @store.all_classes_and_modules.select { |mod| mod.display? } - - assert_empty visible.map { |mod| mod.full_name } - end - - def test_scan_constant_in_method - content = <<-CONTENT # newline is after M is important -module M - def m - A - B::C - end -end - CONTENT - - util_parser content - - @parser.scan - - m = @top_level.modules.first - - assert_empty m.constants - - assert_empty @store.classes_hash.keys - assert_equal %w[M], @store.modules_hash.keys - end - - def test_scan_constant_in_rescue - content = <<-CONTENT # newline is after M is important -module M - def m - rescue A::B - rescue A::C => e - rescue A::D, A::E - rescue A::F, - A::G - rescue H - rescue I => e - rescue J, K - rescue L => - e - rescue M; - rescue N, - O => e - end -end - CONTENT - - util_parser content - - @parser.scan - - m = @top_level.modules.first - - assert_empty m.constants - - assert_empty @store.classes_hash.keys - assert_equal %w[M], @store.modules_hash.keys - end - - def test_scan_constant_nodoc - content = <<-CONTENT # newline is after M is important -module M - - C = v # :nodoc: -end - CONTENT - - util_parser content - - @parser.scan - - c = @top_level.modules.first.constants.first - - assert c.documented? - end - - def test_scan_constant_nodoc_block - content = <<-CONTENT # newline is after M is important -module M - - C = v do # :nodoc: - end -end - CONTENT - - util_parser content - - @parser.scan - - c = @top_level.modules.first.constants.first - - assert c.documented? - end - - def test_scan_duplicate_module - content = <<-CONTENT -# comment a -module Foo -end - -# comment b -module Foo -end - CONTENT - - util_parser content - - @parser.scan - - foo = @top_level.modules.first - - expected = [ - RDoc::Comment.new('comment a', @top_level), - RDoc::Comment.new('comment b', @top_level) - ] - - assert_equal expected, foo.comment_location.map { |c, l| c } - end - - def test_scan_meta_method_block - content = <<-CONTENT -class C - - ## - # my method - - inline(:my_method) do |*args| - "this method used to cause z to disappear" - end - - def z - end - CONTENT - - util_parser content - - @parser.scan - - assert_equal 2, @top_level.classes.first.method_list.length - end - - def test_scan_method_semi_method - content = <<-CONTENT -class A - def self.m() end; def self.m=() end -end - -class B - def self.m() end -end - CONTENT - - util_parser content - - @parser.scan - - a = @store.find_class_named 'A' - assert a, 'missing A' - - assert_equal 2, a.method_list.length - - b = @store.find_class_named 'B' - assert b, 'missing B' - - assert_equal 1, b.method_list.length - end - - def test_scan_markup_override - content = <<-CONTENT -# *awesome* -class C - # :markup: rd - # ((*radical*)) - def m - end -end - CONTENT - - util_parser content - - @parser.scan - - c = @top_level.classes.first - - assert_equal 'rdoc', c.comment.format - - assert_equal 'rd', c.method_list.first.comment.format - end - - def test_scan_markup_first_comment - content = <<-CONTENT -# :markup: rd - -# ((*awesome*)) -class C - # ((*radical*)) - def m - end -end - CONTENT - - util_parser content - - @parser.scan - - c = @top_level.classes.first - - assert_equal 'rd', c.comment.format - - assert_equal 'rd', c.method_list.first.comment.format - end - - def test_scan_rails_routes - util_parser <<-ROUTES_RB -namespace :api do - scope module: :v1 do - end -end - ROUTES_RB - - @parser.scan - - assert_empty @top_level.classes - assert_empty @top_level.modules - end - - def test_scan_tomdoc_meta - util_parser <<-RUBY -# :markup: tomdoc - -class C - - # Signature - # - # find_by_<field>[_and_<field>...](args) - # - # field - A field name. - -end - - RUBY - - @parser.scan - - c = @top_level.classes.first - - m = c.method_list.first - - assert_equal "find_by_<field>[_and_<field>...]", m.name - assert_equal "find_by_<field>[_and_<field>...](args)\n", m.call_seq - - expected = - doc( - head(3, 'Signature'), - list(:NOTE, - item(%w[field], - para('A field name.')))) - expected.file = @top_level - - assert_equal expected, m.comment.parse - end - - def test_scan_stopdoc - util_parser <<-RUBY -class C - # :stopdoc: - class Hidden - end -end - RUBY - - @parser.scan - - c = @top_level.classes.first - - hidden = c.classes.first - - refute hidden.document_self - assert hidden.ignored? - end - - def test_scan_stopdoc_class_alias - util_parser <<-RUBY -# :stopdoc: -module A - B = C -end - RUBY - - @parser.scan - - assert_empty @store.all_classes - - assert_equal 1, @store.all_modules.length - m = @store.all_modules.first - - assert m.ignored? - end - - def test_scan_stopdoc_nested - util_parser <<-RUBY -# :stopdoc: -class A::B -end - RUBY - - @parser.scan - - a = @store.modules_hash['A'] - a_b = @store.classes_hash['A::B'] - - refute a.document_self, 'A is inside stopdoc' - assert a.ignored?, 'A is inside stopdoc' - - refute a_b.document_self, 'A::B is inside stopdoc' - assert a_b.ignored?, 'A::B is inside stopdoc' - end - - def test_scan_struct_self_brackets - util_parser <<-RUBY -class C < M.m - def self.[] - end -end - RUBY - - @parser.scan - - c = @store.find_class_named 'C' - assert_equal %w[C::[]], c.method_list.map { |m| m.full_name } - end - - def test_scan_visibility - util_parser <<-RUBY -class C - def a() end - - private :a - - class << self - def b() end - private :b - end -end - RUBY - - @parser.scan - - c = @store.find_class_named 'C' - - c_a = c.find_method_named 'a' - - assert_equal :private, c_a.visibility - refute c_a.singleton - - c_b = c.find_method_named 'b' - - assert_equal :private, c_b.visibility - assert c_b.singleton - end - - def test_scan_visibility_count - util_parser <<-RUBY -class C < Original::Base - class C2 < Original::Base - def m0() end - def m1() end - - private - - def m2() end - def m3() end - def m4() end - end -end - RUBY - - @parser.scan - - c = @store.find_class_named 'C::C2' - - private_method_count = c.method_list.count { |m| :private == m.visibility } - assert_equal 3, private_method_count - - public_method_count = c.method_list.count { |m| :public == m.visibility } - assert_equal 2, public_method_count - end - - def test_scan_constant_visibility - util_parser <<-RUBY -class C - CONST_A = 123 - - CONST_B = 234 - private_constant :CONST_B - - CONST_C = 345 - public_constant :CONST_C -end - RUBY - - @parser.scan - - c = @store.find_class_named 'C' - const_a, const_b, const_c = c.constants.sort_by(&:name) - - assert_equal 'CONST_A', const_a.name - assert_equal :public, const_a.visibility - - assert_equal 'CONST_B', const_b.name - assert_equal :private, const_b.visibility - - assert_equal 'CONST_C', const_c.name - assert_equal :public, const_c.visibility - end - - def test_document_after_rescue_inside_paren - util_parser <<-RUBY -class C - attr_accessor :sample if (1.inexistent_method rescue false) - # first - # second - def a - end -end - RUBY - - @parser.scan - - c = @store.find_class_named 'C' - - c_a = c.find_method_named 'a' - assert_equal "first\nsecond", c_a.comment.text - end - - def test_singleton_method_via_eigenclass - util_parser <<-RUBY -class C - class << self - def a() end - end -end - RUBY - - @parser.scan - - c = @store.find_class_named 'C' - c_a = c.find_method_named 'a' - - assert_equal :public, c_a.visibility - assert c_a.singleton - end - - def test_stopdoc_after_comment - util_parser <<-EOS - module Bar - # hello - module Foo - # :stopdoc: - end - # there - class Baz - # :stopdoc: - end - end - EOS - - @parser.parse_statements @top_level - - foo = @top_level.modules.first.modules.first - assert_equal 'Foo', foo.name - assert_equal 'hello', foo.comment.text - - baz = @top_level.modules.first.classes.first - assert_equal 'Baz', baz.name - assert_equal 'there', baz.comment.text - end - - def util_parser(content) - @parser = RDoc::Parser::Ruby.new @top_level, @filename, content, @options, - @stats - end - - def util_two_parsers(first_file_content, second_file_content) - util_parser first_file_content - - @parser2 = RDoc::Parser::Ruby.new @top_level2, @filename, - second_file_content, @options, @stats - end - - def test_parse_const_third_party - util_parser <<-CLASS -class A - true if B - true if B::C - true if B::C::D - - module B - end -end - CLASS - - tk = @parser.get_tk - - @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment - - a = @top_level.classes.first - assert_equal 'A', a.full_name - - visible = @store.all_modules.reject { |mod| mod.suppressed? } - visible = visible.map { |mod| mod.full_name } - - assert_equal ['A::B'], visible - end - - def test_parse_const_alias_defined_elsewhere - util_parser <<-CLASS -module A - Aliased = Defined -end - -module A - class Defined - end -end - CLASS - - @parser.scan - - a = @top_level.modules.first - assert_equal 'A', a.full_name - aliased = a.constants.first - assert_equal 'A::Aliased', aliased.full_name - assert_equal [], a.modules.map(&:full_name) - assert_equal ['A::Defined', 'A::Aliased'], a.classes.map(&:full_name) - assert_equal ['A::Aliased'], a.constants.map(&:full_name) - - visible = @store.all_modules.reject { |mod| mod.suppressed? } - visible = visible.map { |mod| mod.full_name } - - assert_equal ['A'], visible - end - - def test_parse_const_alias_defined_far_away - util_parser <<-CLASS -module A - Aliased = ::B::C::Defined -end - -module B - module C - class Defined - end - end -end - CLASS - - @parser.scan - - a = @top_level.modules.first - assert_equal 'A', a.full_name - assert_empty a.classes - assert_empty a.modules - assert_equal ['A::Aliased'], a.constants.map(&:full_name) - - defined = @store.find_class_named 'B::C::Defined' - assert_equal 'B::C::Defined', defined.full_name - - aliased = @store.find_class_named 'B::C::Aliased' - assert_equal 'B::C::Aliased', aliased.full_name - - visible = @store.all_modules.reject { |mod| mod.suppressed? } - visible = visible.map { |mod| mod.full_name } - - assert_equal ['A', 'B', 'B::C'], visible - end - - def test_parse_include_by_dynamic_definition - util_parser <<-CLASS -module A - class B - include(Module.new do - def e(m) - end - end) - end - - class C - end - - class D - end -end - CLASS - - @parser.scan - - a = @store.find_module_named 'A' - assert_equal 'A', a.full_name - a_b = a.find_class_named 'B' - assert_equal 'A::B', a_b.full_name - a_c = a.find_class_named 'C' - assert_equal 'A::C', a_c.full_name - a_d = a.find_class_named 'D' - assert_equal 'A::D', a_d.full_name - end - - def test_parse_include_by_dynamic_definition_without_paren - util_parser <<-CLASS -module A - class B - include(Module.new do - def e m - end - end) - end - - class C - end - - class D - end -end - CLASS - - @parser.scan - - a = @store.find_module_named 'A' - assert_equal 'A', a.full_name - a_b = a.find_class_named 'B' - assert_equal 'A::B', a_b.full_name - a_c = a.find_class_named 'C' - assert_equal 'A::C', a_c.full_name - a_d = a.find_class_named 'D' - assert_equal 'A::D', a_d.full_name - end - - def test_parse_include_by_dynamic_definition_via_variable - util_parser <<-CLASS -module A - class B - m = Module.new do - def e(m) - end - end - include m - end - - class C - end - - class D - end -end - CLASS - - @parser.scan - - a = @store.find_module_named 'A' - assert_equal 'A', a.full_name - a_b = a.find_class_named 'B' - assert_equal 'A::B', a_b.full_name - a_c = a.find_class_named 'C' - assert_equal 'A::C', a_c.full_name - a_d = a.find_class_named 'D' - assert_equal 'A::D', a_d.full_name - end - - def test_parse_include_by_dynamic_definition_with_brace - util_parser <<-CLASS -module A - class B - extend(e { - def f(g) - end - }) - end - - class C - end - - class D - end -end - CLASS - - @parser.scan - - a = @store.find_module_named 'A' - assert_equal 'A', a.full_name - a_b = a.find_class_named 'B' - assert_equal 'A::B', a_b.full_name - a_c = a.find_class_named 'C' - assert_equal 'A::C', a_c.full_name - a_d = a.find_class_named 'D' - assert_equal 'A::D', a_d.full_name - end - - def test_parse_include_by_dynamic_definition_directly - util_parser <<-CLASS -module A - class B - include Module.new do - def e m - end - end - end - - class C - end - - class D - end -end - CLASS - - @parser.scan - - a = @store.find_module_named 'A' - assert_equal 'A', a.full_name - a_b = a.find_class_named 'B' - assert_equal 'A::B', a_b.full_name - a_c = a.find_class_named 'C' - assert_equal 'A::C', a_c.full_name - a_d = a.find_class_named 'D' - assert_equal 'A::D', a_d.full_name - end - - def test_parse_included - util_parser <<-CLASS -module A - module B - extend ActiveSupport::Concern - included do - ## - # :singleton-method: - # Hello - mattr_accessor :foo - end - end -end - CLASS - - @parser.scan - - a = @store.find_module_named 'A' - assert_equal 'A', a.full_name - a_b = a.find_module_named 'B' - assert_equal 'A::B', a_b.full_name - meth = a_b.method_list.first - assert_equal 'foo', meth.name - assert_equal 'Hello', meth.comment.text - end - - def test_end_that_doesnt_belong_to_class_doesnt_change_visibility - util_parser <<-CLASS -class A - private - - begin - end - - # Hello - def foo() end -end - CLASS - - @parser.scan - - a = @store.find_class_named 'A' - assert_equal 'A', a.full_name - assert_equal 'foo', a.find_method_named('foo').name - meth = a.method_list.first - assert_equal 'Hello', meth.comment.text - end - - def test_parenthesized_cdecl - util_parser <<-RUBY -module DidYouMean - class << (NameErrorCheckers = Object.new) - end -end - RUBY - - @parser.scan - - refute_predicate @store.find_class_or_module('DidYouMean'), :nil? - refute_predicate @store.find_class_or_module('DidYouMean::NameErrorCheckers'), :nil? - end -end diff --git a/test/rdoc/test_rdoc_parser_simple.rb b/test/rdoc/test_rdoc_parser_simple.rb deleted file mode 100644 index 4255cb97d8..0000000000 --- a/test/rdoc/test_rdoc_parser_simple.rb +++ /dev/null @@ -1,115 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocParserSimple < RDoc::TestCase - - def setup - super - - @tempfile = Tempfile.new self.class.name - filename = @tempfile.path - - @top_level = @store.add_file filename - @fn = filename - @options = RDoc::Options.new - @stats = RDoc::Stats.new @store, 0 - end - - def teardown - super - - @tempfile.close! - end - - def test_initialize_metadata - parser = util_parser ":unhandled: \n" - - assert_includes @top_level.metadata, 'unhandled' - - assert_equal ":unhandled: \n", parser.content - end - - def test_remove_coding_comment - parser = util_parser <<-TEXT -# -*- mode: rdoc; coding: utf-8; fill-column: 74; -*- - -Regular expressions (<i>regexp</i>s) are patterns which describe the -contents of a string. - TEXT - - parser.scan - - expected = <<-TEXT.strip -Regular expressions (<i>regexp</i>s) are patterns which describe the -contents of a string. - TEXT - - assert_equal expected, @top_level.comment.text - end - - # RDoc stops processing comments if it finds a comment line CONTAINING - # '<tt>#--</tt>'. This can be used to separate external from internal - # comments, or to stop a comment being associated with a method, - # class, or module. Commenting CAN be turned back on with - # a line that STARTS '<tt>#++</tt>'. - # - # I've seen guys that comment their code like this: - # # This method.... - # #----------------- - # def method - # - # => either we do it only in ruby code, or we require the leading # - # (to avoid conflict with rules). - # - # TODO: require the leading #, to provide the feature in simple text files. - # Note: in ruby & C code, we require '#--' & '#++' or '*--' & '*++', - # to allow rules: - # - # # this is a comment - # #--- - # # private text - # #+++ - # # this is a rule: - # # --- - - def test_remove_private_comments - parser = util_parser "foo\n\n--\nbar\n++\n\nbaz\n" - - parser.scan - - expected = "foo\n\n\nbaz" - - assert_equal expected, @top_level.comment.text - end - - def test_remove_private_comments_rule - parser = util_parser "foo\n---\nbar" - - parser.scan - - expected = "foo\n---\nbar" - - assert_equal expected, @top_level.comment.text - end - - def test_remove_private_comments_star - parser = util_parser "* foo\n* bar\n" - - parser.scan - - assert_equal "* foo\n* bar", @top_level.comment.text - end - - def test_scan - parser = util_parser 'it *really* works' - - parser.scan - - assert_equal 'it *really* works', @top_level.comment.text - end - - def util_parser(content) - RDoc::Parser::Simple.new @top_level, @fn, content, @options, @stats - end - -end diff --git a/test/rdoc/test_rdoc_rd.rb b/test/rdoc/test_rdoc_rd.rb deleted file mode 100644 index 38de575bb0..0000000000 --- a/test/rdoc/test_rdoc_rd.rb +++ /dev/null @@ -1,30 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocRd < RDoc::TestCase - - def test_class_parse - expected = - @RM::Document.new( - @RM::Paragraph.new('hello')) - - assert_equal expected, RDoc::RD.parse("hello") - end - - def test_class_parse_begin_end - expected = - @RM::Document.new( - @RM::Paragraph.new('hello')) - - assert_equal expected, RDoc::RD.parse("=begin\nhello\n=end\n") - end - - def test_class_parse_newline - expected = - @RM::Document.new( - @RM::Paragraph.new('hello')) - - assert_equal expected, RDoc::RD.parse("hello\n") - end - -end diff --git a/test/rdoc/test_rdoc_rd_block_parser.rb b/test/rdoc/test_rdoc_rd_block_parser.rb deleted file mode 100644 index ca0ac9f9e9..0000000000 --- a/test/rdoc/test_rdoc_rd_block_parser.rb +++ /dev/null @@ -1,557 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocRdBlockParser < RDoc::TestCase - - def setup - super - - @block_parser = RDoc::RD::BlockParser.new - end - - def test_add_footnote - index = @block_parser.add_footnote 'context' - - assert_equal 1, index - - expected = [ - para('{^1}[rdoc-label:footmark-1:foottext-1]', ' ', 'context'), - blank_line, - ] - - assert_equal expected, @block_parser.footnotes - - index = @block_parser.add_footnote 'other' - - assert_equal 2, index - end - - def test_parse_desclist - list = <<-LIST -:one - desc one -:two - desc two - LIST - - expected = - doc( - list(:NOTE, - item("one", para("desc one")), - item("two", para("desc two")))) - - assert_equal expected, parse(list) - end - - def test_parse_enumlist - list = <<-LIST -(1) one -(1) two - LIST - - expected = - doc( - list(:NUMBER, - item(nil, para("one")), - item(nil, para("two")))) - - assert_equal expected, parse(list) - end - - def test_parse_enumlist_paragraphs - list = <<-LIST -(1) one - - two - LIST - - expected = - doc( - list(:NUMBER, - item(nil, - para("one"), - para("two")))) - - assert_equal expected, parse(list) - end - - def test_parse_enumlist_multiline - list = <<-LIST -(1) one - two - LIST - - contents = "one\n two" # 1.8 vs 1.9 - - expected = - doc( - list(:NUMBER, - item(nil, para(*contents)))) - - assert_equal expected, parse(list) - end - - def test_parse_enumlist_verbatim - list = <<-LIST -(1) item - verbatim - LIST - - expected = - doc( - list(:NUMBER, - item(nil, - para("item"), - verb("verbatim\n")))) - - assert_equal expected, parse(list) - end - - def test_parse_enumlist_verbatim_continue - list = <<-LIST -(1) one - verbatim - two - LIST - - expected = - doc( - list(:NUMBER, - item(nil, - para("one"), - verb("verbatim\n"), - para("two")))) - - assert_equal expected, parse(list) - end - - def test_parse_footnote - expected = - doc( - para("{*1}[rdoc-label:foottext-1:footmark-1]"), - rule(1), - para("{^1}[rdoc-label:footmark-1:foottext-1]", " ", "text"), - blank_line) - - assert_equal expected, parse("((-text-))") - end - - def test_parse_include - @block_parser.include_path = [Dir.tmpdir] - - expected = doc(@RM::Include.new("parse_include", [Dir.tmpdir])) - - assert_equal expected, parse("<<< parse_include") - end - - def test_parse_include_subtree - @block_parser.include_path = [Dir.tmpdir] - - expected = - doc( - blank_line, - para("include <em>worked</em>"), - blank_line, - blank_line) - - tf = Tempfile.open %w[parse_include .rd] do |io| - io.puts "=begin\ninclude ((*worked*))\n=end" - io.flush - - str = <<-STR -<<< #{File.basename io.path} - STR - - assert_equal expected, parse(str) - io - end - tf.close! - end - -=begin - def test_parse_include_other_format - @block_parser.include_path = [Dir.tmpdir] - - expected = - doc( - blank_line, - para("include ((*worked*))"), - blank_line, - blank_line) - - str = <<~STR - =begin nonrd - <<< worked - =end - STR - - assert_equal(expected, @block_parser.parse str.lines.to_a) - end -=end - - def test_parse_heading - assert_equal doc(head(1, "H")), parse("= H") - assert_equal doc(head(2, "H")), parse("== H") - assert_equal doc(head(3, "H")), parse("=== H") - assert_equal doc(head(4, "H")), parse("==== H") - assert_equal doc(head(5, "H")), parse("+ H") - assert_equal doc(head(6, "H")), parse("++ H") - end - - def test_parse_itemlist - list = <<-LIST -* one -* two - LIST - - expected = - doc( - list(:BULLET, - item(nil, para("one")), - item(nil, para("two")))) - - assert_equal expected, parse(list) - end - - def test_parse_itemlist_multiline - list = <<-LIST -* one - two - LIST - - contents = "one\n two" # 1.8 vs 1.9 - - expected = - doc( - list(:BULLET, - item(nil, para(*contents)))) - - assert_equal expected, parse(list) - end - - def test_parse_itemlist_nest - list = <<-LIST -* one - * inner -* two - LIST - - expected = - doc( - list(:BULLET, - item(nil, - para("one"), - list(:BULLET, - item(nil, para("inner")))), - item(nil, - para("two")))) - - assert_equal expected, parse(list) - end - - def test_parse_itemlist_paragraphs - list = <<-LIST -* one - - two - LIST - - expected = - doc( - list(:BULLET, - item(nil, - para("one"), - para("two")))) - - assert_equal expected, parse(list) - end - - def test_parse_itemlist_verbatim - list = <<-LIST -* item - verbatim - LIST - - expected = - doc( - list(:BULLET, - item(nil, - para("item"), - verb("verbatim\n")))) - - assert_equal expected, parse(list) - end - - def test_parse_itemlist_verbatim_continue - list = <<-LIST -* one - verbatim - two - LIST - - expected = - doc( - list(:BULLET, - item(nil, - para("one"), - verb("verbatim\n"), - para("two")))) - - assert_equal expected, parse(list) - end - - def test_parse_lists - list = <<-LIST -(1) one -(1) two -* three -* four -(1) five -(1) six - LIST - - expected = - doc( - list(:NUMBER, - item(nil, para("one")), - item(nil, para("two"))), - list(:BULLET, - item(nil, para("three")), - item(nil, para("four"))), - list(:NUMBER, - item(nil, para("five")), - item(nil, para("six")))) - - assert_equal expected, parse(list) - end - - def test_parse_lists_nest - list = <<-LIST -(1) one -(1) two - * three - * four -(1) five -(1) six - LIST - - expected = - doc( - list(:NUMBER, - item(nil, para("one")), - item(nil, - para("two"), - list(:BULLET, - item(nil, para("three")), - item(nil, para("four")))), - item(nil, para("five")), - item(nil, para("six")))) - - assert_equal expected, parse(list) - end - - def test_parse_lists_nest_verbatim - list = <<-LIST -(1) one -(1) two - * three - * four - verbatim -(1) five -(1) six - LIST - - expected = - doc( - list(:NUMBER, - item(nil, para("one")), - item(nil, - para("two"), - list(:BULLET, - item(nil, para("three")), - item(nil, para("four"))), - verb("verbatim\n")), - item(nil, para("five")), - item(nil, para("six")))) - - assert_equal expected, parse(list) - end - - def test_parse_lists_nest_verbatim2 - list = <<-LIST -(1) one -(1) two - * three - * four - verbatim -(1) five -(1) six - LIST - - expected = - doc( - list(:NUMBER, - item(nil, para("one")), - item(nil, - para("two"), - list(:BULLET, - item(nil, para("three")), - item(nil, para("four"))), - verb("verbatim\n")), - item(nil, para("five")), - item(nil, para("six")))) - - assert_equal expected, parse(list) - end - - def test_parse_methodlist - list = <<-LIST ---- Array#each {|i| ... } - yield block for each item. ---- Array#index(val) - return index of first item which equals with val. if it hasn't - same item, return nil. - LIST - - expected = - doc( - list(:LABEL, - item( - "<tt>Array#each {|i| ... }</tt>", - para("yield block for each item.")), - item( - "<tt>Array#index(val)</tt>", - para("return index of first item which equals with val. if it hasn't same item, return nil.")))) - - assert_equal expected, parse(list) - end - - def test_parse_methodlist_empty - list = <<-LIST ---- A#b - - LIST - - expected = - doc( - list(:LABEL, - item("<tt>A#b</tt>"))) - - assert_equal expected, parse(list) - end - - def test_parse_methodlist_paragraph - list = <<-LIST ---- A#b - - one - LIST - - expected = - doc( - list(:LABEL, - item( - "<tt>A#b</tt>", - para("one")))) - - assert_equal expected, parse(list) - end - - def test_parse_methodlist_paragraph2 - list = <<-LIST.chomp ---- A#b - - one -two - LIST - - expected = - doc( - list(:LABEL, - item( - "<tt>A#b</tt>", - para("one"))), - para("two")) - - assert_equal expected, parse(list) - end - - def test_parse_methodlist_paragraph_verbatim - list = <<-LIST.chomp ---- A#b - - text - verbatim - LIST - - expected = - doc( - list(:LABEL, - item( - "<tt>A#b</tt>", - para("text"), - verb("verbatim\n")))) - - assert_equal expected, parse(list) - end - - def test_parse_verbatim - assert_equal doc(verb("verbatim\n")), parse(" verbatim") - end - - def test_parse_verbatim_blankline - expected = doc(verb("one\n", "\n", "two\n")) - - verbatim = <<-VERBATIM - one - - two - VERBATIM - - assert_equal expected, parse(verbatim) - end - - def test_parse_verbatim_indent - expected = doc(verb("one\n", " two\n")) - - verbatim = <<-VERBATIM - one - two - VERBATIM - - assert_equal expected, parse(verbatim) - end - - def test_parse_verbatim_multi - expected = doc(verb("one\n", "two\n")) - - verbatim = <<-VERBATIM - one - two - VERBATIM - - assert_equal expected, parse(verbatim) - end - - def test_parse_textblock - assert_equal doc(para("text")), parse("text") - end - - def test_parse_textblock_multi - expected = doc(para("one two")) - - assert_equal expected, parse("one\ntwo") - end - - def parse text - text = ["=begin", text, "=end"].join "\n" - - doc = @block_parser.parse text.lines.to_a - - assert_equal blank_line, doc.parts.shift, "=begin blankline" - assert_equal blank_line, doc.parts.pop, "=end blankline" - - doc - end - -end diff --git a/test/rdoc/test_rdoc_rd_inline.rb b/test/rdoc/test_rdoc_rd_inline.rb deleted file mode 100644 index 6bfb229933..0000000000 --- a/test/rdoc/test_rdoc_rd_inline.rb +++ /dev/null @@ -1,63 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocRdInline < RDoc::TestCase - - def setup - super - - @inline = RDoc::RD::Inline.new '+text+', 'text' - end - - def test_class_new - inline = RDoc::RD::Inline.new @inline - - refute_equal inline.rdoc, inline.reference - end - - def test_initialize - inline = RDoc::RD::Inline.new 'text' - - assert_equal inline.rdoc, inline.reference - refute_same inline.rdoc, inline.reference - end - - def test_initialize_inline - inline = RDoc::RD::Inline.new @inline - - assert_equal '+text+', inline.rdoc - assert_equal 'text', inline.reference - end - - def test_append_inline - out = @inline.append @inline - - assert_same @inline, out - - assert_equal '+text++text+', @inline.rdoc - assert_equal 'texttext', @inline.reference - end - - def test_append_string - @inline.append ' more' - - assert_equal '+text+ more', @inline.rdoc - assert_equal 'text more', @inline.reference - end - - def test_equals2 - assert_equal @inline, RDoc::RD::Inline.new('+text+', 'text') - refute_equal @inline, RDoc::RD::Inline.new('+text+', 'other') - refute_equal @inline, RDoc::RD::Inline.new('+other+', 'text') - refute_equal @inline, Object.new - end - - def test_inspect - assert_equal '(inline: +text+)', @inline.inspect - end - - def test_to_s - assert_equal '+text+', @inline.to_s - end - -end diff --git a/test/rdoc/test_rdoc_rd_inline_parser.rb b/test/rdoc/test_rdoc_rd_inline_parser.rb deleted file mode 100644 index 9aff6139bc..0000000000 --- a/test/rdoc/test_rdoc_rd_inline_parser.rb +++ /dev/null @@ -1,178 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocRdInlineParser < RDoc::TestCase - - def setup - super - - @block_parser = RDoc::RD::BlockParser.new - @block_parser.instance_variable_set :@i, 0 - @inline_parser = RDoc::RD::InlineParser.new @block_parser - end - - def test_parse - assert_equal 'regular <em>emphasis</em>', parse('regular ((*emphasis*))') - end - - def test_parse_code - assert_equal '<code>text</code>', parse('(({text}))') - end - - def test_parse_em - assert_equal '<em>text</em>', parse('((*text*))') - end - - def test_parse_footnote - assert_equal '{*1}[rdoc-label:foottext-1:footmark-1]', parse('((-text-))') - - expected = [ - @RM::Paragraph.new('{^1}[rdoc-label:footmark-1:foottext-1]', ' ', 'text'), - blank_line, - ] - - assert_equal expected, @block_parser.footnotes - end - - def test_parse_index - assert_equal '<span id="label-text">text</span>', parse('((:text:))') - - assert_includes @block_parser.labels, 'text' - end - - def test_parse_kbd - assert_equal '<tt>text</tt>', parse('((%text%))') - end - - def test_parse_multiple - assert_equal '<em>one</em> <em>two</em>', parse('((*one*)) ((*two*))') - end - - def test_parse_newline - assert_equal "one\ntwo", parse("one\ntwo") - end - - def test_parse_quote - assert_equal 'one " two', parse('one " two') - end - - def test_parse_ref - assert_equal '{text}[rdoc-label:text]', parse('((<text>))') - end - - def test_parse_ref_em - assert_equal '{<em>text</em>}[rdoc-label:text]', parse('((<((*text*))>))') - end - - def test_parse_ref_filename_quote - assert_equal '{RD/foo}[rdoc-label:RD/foo]', parse('((<RD/"foo">))') - end - - def test_parse_ref_filename - assert_equal '{RD}[rdoc-label:RD/]', parse('((<RD/>))') - end - - def test_parse_ref_quote - assert_equal '{text \\"}[rdoc-label:text \\"]', parse('((<text \">))') - end - - def test_parse_ref_quote_content - assert_equal '{<em>text</em>}[rdoc-label:text]', - parse('((<"((*text*))">))') - end - - def test_parse_ref_quote_content_multi - assert_equal '{<em>one</em> <em>two</em>}[rdoc-label:one two]', - parse('((<"((*one*)) ((*two*))">))') - end - - def test_parse_ref_substitute - assert_equal '{text}[rdoc-label:thing]', parse('((<text|thing>))') - end - - def test_parse_ref_substitute_element_quote - assert_equal '{text}[rdoc-label:"RD"]', - parse('((<text|"RD">))') - end - - def test_parse_ref_substitute_filename - assert_equal '{text}[rdoc-label:RD/]', parse('((<text|RD/>))') - end - - def test_parse_ref_substitute_filename_label - assert_equal '{text}[rdoc-label:RD/label]', - parse('((<text|RD/label>))') - end - - def test_parse_ref_substitute_filename_quote - assert_equal '{text}[rdoc-label:"RD"/]', parse('((<text|"RD"/>))') - end - - def test_parse_ref_substitute_multi_content - assert_equal '{<em>one</em> two}[rdoc-label:thing]', - parse('((<((*one*)) two|thing>))') - end - - def test_parse_ref_substitute_multi_content2 - assert_equal '{<em>one</em> \\" two}[rdoc-label:thing]', - parse('((<((*one*)) \" two|thing>))') - end - - def test_parse_ref_substitute_multi_content3 - assert_equal '{<em>one</em> \\" <em>two</em>}[rdoc-label:thing]', - parse('((<((*one*)) \" ((*two*))|thing>))') - end - - def test_parse_ref_substitute_quote - assert_equal '{one | two}[rdoc-label:thing]', - parse('((<"one | two"|thing>))') - end - - def test_parse_ref_substitute_quote_content - assert_equal '{<em>text</em>}[rdoc-label:thing]', - parse('((<"((*text*))"|thing>))') - end - - def test_parse_ref_substitute_url - assert_equal '{text}[http://example]', - parse('((<text|URL:http://example>))') - end - - def test_parse_ref_url - assert_equal '{http://example}[http://example]', - parse('((<URL:http://example>))') - end - - def test_parse_var - assert_equal '+text+', parse('((|text|))') - end - - def test_parse_verb - assert_equal '<tt>text</tt>', parse("(('text'))") - end - - def test_parse_verb_backslash - assert_equal "<tt>(('text'))</tt>", parse("(('(('text\\'))'))") - end - - def test_parse_verb_backslash_backslash - assert_equal '<tt>text \\</tt>', parse("(('text \\\\'))") - end - - def test_parse_verb_backslash_quote - assert_equal '<tt>text "</tt>', parse("(('text \\\"'))") - end - - def test_parse_verb_emphasis - assert_equal '<tt>((*emphasis*))</tt>', parse("(('((*emphasis*))'))") - end - - def test_parse_verb_multiple - assert_equal '<tt>((*text*))</tt>', parse("(('((*text*))'))") - end - - def parse text - @inline_parser.parse text - end - -end diff --git a/test/rdoc/test_rdoc_rdoc.rb b/test/rdoc/test_rdoc_rdoc.rb deleted file mode 100644 index 9c94988ffd..0000000000 --- a/test/rdoc/test_rdoc_rdoc.rb +++ /dev/null @@ -1,583 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocRDoc < RDoc::TestCase - - def setup - super - - @rdoc = RDoc::RDoc.new - @rdoc.options = RDoc::Options.new - - @stats = RDoc::Stats.new @store, 0, 0 - @rdoc.instance_variable_set :@stats, @stats - end - - def test_document # functional test - options = RDoc::Options.new - options.files = [File.expand_path('../xref_data.rb', __FILE__)] - options.setup_generator 'ri' - options.main_page = 'MAIN_PAGE.rdoc' - options.root = Pathname File.expand_path('..', __FILE__) - options.title = 'title' - - rdoc = RDoc::RDoc.new - - temp_dir do - options.op_dir = 'ri' - - capture_output do - rdoc.document options - end - - assert File.directory? 'ri' - assert_equal rdoc, rdoc.store.rdoc - end - - store = rdoc.store - - assert_equal 'MAIN_PAGE.rdoc', store.main - assert_equal 'title', store.title - end - - def test_document_with_dry_run # functional test - options = RDoc::Options.new - options.files = [File.expand_path('../xref_data.rb', __FILE__)] - options.setup_generator 'darkfish' - options.main_page = 'MAIN_PAGE.rdoc' - options.root = Pathname File.expand_path('..', __FILE__) - options.title = 'title' - options.dry_run = true - - rdoc = RDoc::RDoc.new - - out = nil - temp_dir do - out, = capture_output do - rdoc.document options - end - - refute File.directory? 'doc' - assert_equal rdoc, rdoc.store.rdoc - end - assert_includes out, '100%' - - store = rdoc.store - - assert_equal 'MAIN_PAGE.rdoc', store.main - assert_equal 'title', store.title - end - - def test_gather_files - a = File.expand_path __FILE__ - b = File.expand_path '../test_rdoc_text.rb', __FILE__ - - assert_equal [a, b], @rdoc.gather_files([b, a, b]) - - assert_empty @rdoc.gather_files([b, a, b]) - - @rdoc.last_modified[a] -= 10 - assert_equal [a, b], @rdoc.gather_files([b, a, b]) - end - - def test_handle_pipe - $stdin = StringIO.new "hello" - - out, = capture_output do - @rdoc.handle_pipe - end - - assert_equal "\n<p>hello</p>\n", out - ensure - $stdin = STDIN - end - - def test_handle_pipe_rd - $stdin = StringIO.new "=begin\nhello\n=end" - - @rdoc.options.markup = 'rd' - - out, = capture_output do - @rdoc.handle_pipe - end - - assert_equal "\n<p>hello</p>\n", out - ensure - $stdin = STDIN - end - - def test_normalized_file_list - test_path = File.expand_path(__FILE__) - files = temp_dir do |dir| - flag_file = @rdoc.output_flag_file dir - - FileUtils.touch flag_file - - @rdoc.normalized_file_list [test_path, flag_file] - end - - files = files.map { |file, *| File.expand_path file } - - assert_equal [test_path], files - end - - def test_normalized_file_list_not_modified - @rdoc.last_modified[__FILE__] = File.stat(__FILE__).mtime - - files = @rdoc.normalized_file_list [__FILE__] - - files = files.collect {|file, mtime| file if mtime}.compact - - assert_empty(files) - end - - def test_normalized_file_list_non_file_directory - dev = File::NULL - omit "#{dev} is not a character special" unless - File.chardev? dev - - files = nil - - out, err = verbose_capture_output do - files = @rdoc.normalized_file_list [dev] - end - - files = files.map { |file| File.expand_path file } - - assert_empty files - - assert_empty out - assert_match %r"^rdoc can't parse", err - assert_match %r"#{dev}$", err - end - - def test_normalized_file_list_with_dot_doc - expected_files = [] - files = temp_dir do |dir| - a = File.expand_path('a.rb') - b = File.expand_path('b.rb') - c = File.expand_path('c.rb') - FileUtils.touch a - FileUtils.touch b - FileUtils.touch c - # Use Dir.glob to convert short path of Dir.tmpdir to long path. - a = Dir.glob(a).first - b = Dir.glob(b).first - c = Dir.glob(c).first - - File.write('.document', "a.rb\n""b.rb\n") - expected_files << a - expected_files << b - - @rdoc.normalized_file_list [File.realpath(dir)] - end - - files = files.map { |file, *| File.expand_path file } - - assert_equal expected_files, files - end - - def test_normalized_file_list_with_dot_doc_overridden_by_exclude_option - expected_files = [] - files = temp_dir do |dir| - a = File.expand_path('a.rb') - b = File.expand_path('b.rb') - c = File.expand_path('c.rb') - FileUtils.touch a - FileUtils.touch b - FileUtils.touch c - # Use Dir.glob to convert short path of Dir.tmpdir to long path. - a = Dir.glob(a).first - b = Dir.glob(b).first - c = Dir.glob(c).first - - File.write('.document', "a.rb\n""b.rb\n") - expected_files << a - - @rdoc.options.exclude = /b\.rb$/ - @rdoc.normalized_file_list [File.realpath(dir)] - end - - files = files.map { |file, *| File.expand_path file } - - assert_equal expected_files, files - end - - def test_normalized_file_list_with_skipping_tests_enabled - files = temp_dir do |dir| - @a = File.expand_path('a.rb') - spec_dir = File.expand_path('spec') - spec_file = File.expand_path(File.join('spec', 'my_spec.rb')) - test_dir = File.expand_path('test') - test_file = File.expand_path(File.join('test', 'my_test.rb')) - FileUtils.touch @a - FileUtils.mkdir_p spec_dir - FileUtils.touch spec_file - FileUtils.mkdir_p test_dir - FileUtils.touch test_file - - @rdoc.options.skip_tests = true - @rdoc.normalized_file_list [File.realpath(dir)] - end - - files = files.map { |file, *| File.expand_path file } - assert_equal [@a], files - end - - def test_normalized_file_list_with_skipping_tests_disabled - files = temp_dir do |dir| - @a = File.expand_path('a.rb') - spec_dir = File.expand_path('spec') - @spec_file = File.expand_path(File.join('spec', 'my_spec.rb')) - test_dir = File.expand_path('test') - @test_file = File.expand_path(File.join('test', 'my_test.rb')) - FileUtils.touch @a - FileUtils.mkdir_p spec_dir - FileUtils.touch @spec_file - FileUtils.mkdir_p test_dir - FileUtils.touch @test_file - - @rdoc.options.skip_tests = false - @rdoc.normalized_file_list [File.realpath(dir)] - end - - files = files.map { |file, *| File.expand_path file } - assert_equal [@a, @spec_file, @test_file], files.sort - end - - def test_parse_file - @rdoc.store = RDoc::Store.new - - temp_dir do |dir| - @rdoc.options.root = Pathname(Dir.pwd) - - File.open 'test.txt', 'w' do |io| - io.puts 'hi' - end - - top_level = @rdoc.parse_file 'test.txt' - - assert_equal 'test.txt', top_level.absolute_name - assert_equal 'test.txt', top_level.relative_name - end - end - - def test_parse_file_binary - @rdoc.store = RDoc::Store.new - - root = File.dirname __FILE__ - - @rdoc.options.root = Pathname root - - out, err = capture_output do - Dir.chdir root do - assert_nil @rdoc.parse_file 'binary.dat' - end - end - - assert_empty out - assert_empty err - end - - def test_parse_file_include_root - @rdoc.store = RDoc::Store.new - - test_path = File.expand_path('..', __FILE__) - top_level = nil - temp_dir do |dir| - @rdoc.options.parse %W[--root #{test_path}] - @rdoc.options.finish - - File.open 'include.txt', 'w' do |io| - io.puts ':include: test.txt' - end - - out, err = capture_output do - top_level = @rdoc.parse_file 'include.txt' - end - assert_empty out - assert_empty err - end - assert_equal "test file", top_level.comment.text - end - - def test_parse_file_page_dir - @rdoc.store = RDoc::Store.new - - temp_dir do |dir| - FileUtils.mkdir 'pages' - @rdoc.options.page_dir = Pathname('pages') - @rdoc.options.root = Pathname(Dir.pwd) - - File.open 'pages/test.txt', 'w' do |io| - io.puts 'hi' - end - - top_level = @rdoc.parse_file 'pages/test.txt' - - assert_equal 'pages/test.txt', top_level.absolute_name - assert_equal 'test.txt', top_level.relative_name - end - end - - def test_parse_file_relative - pwd = Dir.pwd - - @rdoc.store = RDoc::Store.new - - temp_dir do |dir| - @rdoc.options.root = Pathname(dir) - - File.open 'test.txt', 'w' do |io| - io.puts 'hi' - end - - test_txt = File.join dir, 'test.txt' - - Dir.chdir pwd do - top_level = @rdoc.parse_file test_txt - - assert_equal test_txt, top_level.absolute_name - assert_equal 'test.txt', top_level.relative_name - end - end - end - - def test_parse_file_encoding - @rdoc.options.encoding = Encoding::ISO_8859_1 - @rdoc.store = RDoc::Store.new - - tf = Tempfile.open 'test.txt' do |io| - io.write 'hi' - io.rewind - - top_level = @rdoc.parse_file io.path - - assert_equal Encoding::ISO_8859_1, top_level.absolute_name.encoding - io - end - tf.close! - end - - def test_parse_file_forbidden - omit 'chmod not supported' if Gem.win_platform? - omit "assumes that euid is not root" if Process.euid == 0 - - @rdoc.store = RDoc::Store.new - - tf = Tempfile.open 'test.txt' do |io| - io.write 'hi' - io.rewind - - File.chmod 0000, io.path - - begin - top_level = :bug - - _, err = capture_output do - top_level = @rdoc.parse_file io.path - end - - assert_match "Unable to read #{io.path},", err - - assert_nil top_level - ensure - File.chmod 0400, io.path - end - io - end - tf.close! - end - - def test_remove_unparseable - file_list = %w[ - blah.class - blah.eps - blah.erb - blah.scpt.txt - blah.svg - blah.ttf - blah.yml - ] - - assert_empty @rdoc.remove_unparseable file_list - end - - def test_remove_unparseable_tags_emacs - temp_dir do - File.open 'TAGS', 'wb' do |io| # emacs - io.write "\f\nlib/foo.rb,43\n" - end - - file_list = %w[ - TAGS - ] - - assert_empty @rdoc.remove_unparseable file_list - end - end - - def test_remove_unparseable_tags_vim - temp_dir do - File.open 'TAGS', 'w' do |io| # emacs - io.write "!_TAG_" - end - - file_list = %w[ - TAGS - ] - - assert_empty @rdoc.remove_unparseable file_list - end - end - - def test_remove_unparseable_CVE_2021_31799 - omit 'for Un*x platforms' if Gem.win_platform? - temp_dir do - file_list = ['| touch evil.txt && echo tags'] - file_list.each do |f| - FileUtils.touch f rescue omit - end - - assert_equal file_list, @rdoc.remove_unparseable(file_list) - assert_equal file_list, Dir.children('.') - end - end - - def test_setup_output_dir - Dir.mktmpdir {|d| - path = File.join d, 'testdir' - - last = @rdoc.setup_output_dir path, false - - assert_empty last - - assert File.directory? path - assert File.exist? @rdoc.output_flag_file path - } - end - - def test_setup_output_dir_dry_run - @rdoc.options.dry_run = true - - Dir.mktmpdir do |d| - path = File.join d, 'testdir' - - @rdoc.setup_output_dir path, false - - refute File.exist? path - end - end - - def test_setup_output_dir_exists - Dir.mktmpdir {|path| - File.open @rdoc.output_flag_file(path), 'w' do |io| - io.puts Time.at 0 - io.puts "./lib/rdoc.rb\t#{Time.at 86400}" - end - - last = @rdoc.setup_output_dir path, false - - assert_equal 1, last.size - assert_equal Time.at(86400), last['./lib/rdoc.rb'] - } - end - - def test_setup_output_dir_exists_empty_created_rid - Dir.mktmpdir {|path| - File.open @rdoc.output_flag_file(path), 'w' do end - - e = assert_raise RDoc::Error do - @rdoc.setup_output_dir path, false - end - - assert_match %r%Directory #{Regexp.escape path} already exists%, e.message - } - end - - def test_setup_output_dir_exists_file - tf = Tempfile.open 'test_rdoc_rdoc' do |tempfile| - path = tempfile.path - - e = assert_raise RDoc::Error do - @rdoc.setup_output_dir path, false - end - - assert_match(%r%#{Regexp.escape path} exists and is not a directory%, - e.message) - tempfile - end - tf.close! - end - - def test_setup_output_dir_exists_not_rdoc - Dir.mktmpdir do |dir| - e = assert_raise RDoc::Error do - @rdoc.setup_output_dir dir, false - end - - assert_match %r%Directory #{Regexp.escape dir} already exists%, e.message - end - end - - def test_update_output_dir - Dir.mktmpdir do |d| - @rdoc.update_output_dir d, Time.now, {} - - assert File.exist? "#{d}/created.rid" - end - end - - def test_update_output_dir_dont - Dir.mktmpdir do |d| - @rdoc.options.update_output_dir = false - @rdoc.update_output_dir d, Time.now, {} - - refute File.exist? "#{d}/created.rid" - end - end - - def test_update_output_dir_dry_run - Dir.mktmpdir do |d| - @rdoc.options.dry_run = true - @rdoc.update_output_dir d, Time.now, {} - - refute File.exist? "#{d}/created.rid" - end - end - - def test_update_output_dir_with_reproducible_time - Dir.mktmpdir do |d| - backup_epoch = ENV['SOURCE_DATE_EPOCH'] - ruby_birthday = Time.parse 'Wed, 24 Feb 1993 21:00:00 +0900' - ENV['SOURCE_DATE_EPOCH'] = ruby_birthday.to_i.to_s - - @rdoc.update_output_dir d, Time.now, {} - - assert File.exist? "#{d}/created.rid" - - f = File.open("#{d}/created.rid", 'r') - head_timestamp = Time.parse f.gets.chomp - f.close - assert_equal ruby_birthday, head_timestamp - - ENV['SOURCE_DATE_EPOCH'] = backup_epoch - end - end - - def test_normalized_file_list_removes_created_rid_dir - temp_dir do |d| - FileUtils.mkdir "doc" - flag_file = @rdoc.output_flag_file "doc" - file = File.join "doc", "test" - FileUtils.touch flag_file - FileUtils.touch file - - file_list = ["doc"] - - output = @rdoc.normalized_file_list file_list - - assert_empty output - end - end -end diff --git a/test/rdoc/test_rdoc_require.rb b/test/rdoc/test_rdoc_require.rb deleted file mode 100644 index 4cc53e6c6c..0000000000 --- a/test/rdoc/test_rdoc_require.rb +++ /dev/null @@ -1,25 +0,0 @@ -# frozen_string_literal: true -require_relative 'xref_test_case' - -class TestRDocRequire < XrefTestCase - - def setup - super - - @req = RDoc::Require.new 'foo', 'comment' - end - - def test_initialize - assert_equal 'foo', @req.name - - RDoc::Require.new '"foo"', '' - assert_equal 'foo', @req.name - - RDoc::Require.new '\'foo\'', '' - assert_equal 'foo', @req.name - - RDoc::Require.new '|foo|', '' - assert_equal 'foo', @req.name, 'for fortran?' - end - -end diff --git a/test/rdoc/test_rdoc_ri_driver.rb b/test/rdoc/test_rdoc_ri_driver.rb deleted file mode 100644 index 37372391cf..0000000000 --- a/test/rdoc/test_rdoc_ri_driver.rb +++ /dev/null @@ -1,1612 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class RDocRIDriverTest < RDoc::TestCase - - def setup - super - - @home_ri = File.join @test_home, 'dot_ri' - - FileUtils.mkdir_p @home_ri - - @orig_ri = ENV.delete('RI') - @rdoc_home = File.join @test_home, ".rdoc" - FileUtils.mkdir_p @rdoc_home - - @options = RDoc::RI::Driver.default_options - @options[:use_system] = false - @options[:use_site] = false - @options[:use_home] = false - @options[:use_gems] = false - - @options[:home] = @rdoc_home - @options[:use_stdout] = true - @options[:formatter] = @RM::ToRdoc - - @driver = RDoc::RI::Driver.new @options - end - - def teardown - defined?(@orig_ri) and ENV['RI'] = @orig_ri - - super - end - - case RUBY_PLATFORM - when /mswin|mingw/ - DUMMY_PAGER = "type nul" - else - DUMMY_PAGER = "true" - end - - def with_dummy_pager - pager_env, ENV['RI_PAGER'] = ENV['RI_PAGER'], DUMMY_PAGER - yield - ensure - ENV['RI_PAGER'] = pager_env - end - - def test_self_dump - util_store - - out, = capture_output do - RDoc::RI::Driver.dump @store1.cache_path - end - - assert_match %r%:class_methods|class_methods:%, out - assert_match %r%:modules|modules:%, out - assert_match %r%:instance_methods|instance_methods:%, out - assert_match %r%:ancestors|ancestors:%, out - end - - def test_add_also_in_empty - out = @RM::Document.new - - @driver.add_also_in out, [] - - assert_empty out - end - - def test_add_also_in - util_multi_store - @store1.type = :system - @store2.type = :home - - out = @RM::Document.new - - @driver.add_also_in out, [@store1, @store2] - - expected = @RM::Document.new( - @RM::Rule.new(1), - @RM::Paragraph.new('Also found in:'), - @RM::Verbatim.new("ruby core", "\n", - @rdoc_home, "\n")) - - assert_equal expected, out - end - - def test_add_class - util_multi_store - - out = @RM::Document.new - - @driver.add_class out, 'Bar', [@cBar] - - expected = @RM::Document.new( - @RM::Heading.new(1, 'Bar < Foo'), - @RM::BlankLine.new) - - assert_equal expected, out - end - - def test_add_from - util_store - @store1.type = :system - - out = @RM::Document.new - - @driver.add_from out, @store1 - - expected = @RM::Document.new @RM::Paragraph.new("(from ruby core)") - - assert_equal expected, out - end - - def test_add_extends - util_store - - out = @RM::Document.new - - @driver.add_extends out, [[[@cFooExt], @store1]] - - expected = @RM::Document.new( - @RM::Rule.new(1), - @RM::Heading.new(1, "Extended by:"), - @RM::Paragraph.new("Ext (from #{@store1.friendly_path})"), - @RM::BlankLine.new, - @RM::Paragraph.new("Extend thingy"), - @RM::BlankLine.new) - - assert_equal expected, out - end - - def test_add_extension_modules_empty - out = @RM::Document.new - - @driver.add_extension_modules out, 'Includes', [] - - assert_empty out - end - - def test_add_extension_modules_many - util_store - - out = @RM::Document.new - - enum = RDoc::Include.new 'Enumerable', nil - @cFoo.add_include enum - - @driver.add_extension_modules out, 'Includes', [[[@cFooInc, enum], @store1]] - - expected = @RM::Document.new( - @RM::Rule.new(1), - @RM::Heading.new(1, "Includes:"), - @RM::Paragraph.new("(from #{@store1.friendly_path})"), - @RM::BlankLine.new, - @RM::Paragraph.new("Inc"), - @RM::BlankLine.new, - @RM::Paragraph.new("Include thingy"), - @RM::BlankLine.new, - @RM::Verbatim.new("Enumerable", "\n")) - - assert_equal expected, out - end - - def test_add_extension_modules_many_no_doc - util_store - - out = @RM::Document.new - - enum = RDoc::Include.new 'Enumerable', nil - @cFoo.add_include enum - @cFooInc.instance_variable_set :@comment, '' - - @driver.add_extension_modules out, 'Includes', [[[@cFooInc, enum], @store1]] - - expected = @RM::Document.new( - @RM::Rule.new(1), - @RM::Heading.new(1, "Includes:"), - @RM::Paragraph.new("(from #{@store1.friendly_path})"), - @RM::Verbatim.new("Inc", "\n", - "Enumerable", "\n")) - - assert_equal expected, out - end - - def test_add_extension_modules_one - util_store - - out = @RM::Document.new - - @driver.add_extension_modules out, 'Includes', [[[@cFooInc], @store1]] - - expected = @RM::Document.new( - @RM::Rule.new(1), - @RM::Heading.new(1, "Includes:"), - @RM::Paragraph.new("Inc (from #{@store1.friendly_path})"), - @RM::BlankLine.new, - @RM::Paragraph.new("Include thingy"), - @RM::BlankLine.new) - - assert_equal expected, out - end - - def test_add_includes - util_store - - out = @RM::Document.new - - @driver.add_includes out, [[[@cFooInc], @store1]] - - expected = @RM::Document.new( - @RM::Rule.new(1), - @RM::Heading.new(1, "Includes:"), - @RM::Paragraph.new("Inc (from #{@store1.friendly_path})"), - @RM::BlankLine.new, - @RM::Paragraph.new("Include thingy"), - @RM::BlankLine.new) - - assert_equal expected, out - end - - def test_add_method - util_store - - out = doc - - @driver.add_method out, 'Foo::Bar#blah' - - expected = - doc( - head(1, 'Foo::Bar#blah'), - blank_line, - para("(from #{@rdoc_home})"), - head(3, 'Implementation from Bar'), - rule(1), - verb("blah(5) => 5\n", - "blah(6) => 6\n"), - rule(1), - blank_line, - blank_line) - - assert_equal expected, out - end - - def test_add_method_with_rdoc_ref_link - util_store - - out = doc - - @driver.add_method out, 'Foo::Bar#blah_with_rdoc_ref' - - expected = - doc( - head(1, 'Foo::Bar#blah_with_rdoc_ref'), - blank_line, - para("(from #{@rdoc_home})"), - head(3, 'Implementation from Bar'), - rule(1), - verb("blah(5) => 5\n", "See also {Doc}[rdoc-ref:README.rdoc]\n"), - rule(1), - blank_line, - blank_line - ) - - assert_equal expected, out - end - - def test_add_method_that_is_alias_for_original - util_store - - out = doc - - @driver.add_method out, 'Qux#aliased' - - expected = - doc( - head(1, 'Qux#aliased'), - blank_line, - para("(from #{@rdoc_home})"), - rule(1), - blank_line, - para('alias comment'), - blank_line, - blank_line, - para('(This method is an alias for Qux#original.)'), - blank_line, - para('original comment'), - blank_line, - blank_line) - - assert_equal expected, out - end - - def test_add_method_attribute - util_store - - out = doc - - @driver.add_method out, 'Foo::Bar#attr' - - expected = - doc( - head(1, 'Foo::Bar#attr'), - blank_line, - para("(from #{@rdoc_home})"), - rule(1), - blank_line, - blank_line) - - assert_equal expected, out - end - - def test_add_method_inherited - util_multi_store - - out = doc - - @driver.add_method out, 'Bar#inherit' - - expected = - doc( - head(1, 'Bar#inherit'), - blank_line, - para("(from #{@rdoc_home})"), - head(3, 'Implementation from Foo'), - rule(1), - blank_line, - blank_line) - - assert_equal expected, out - end - - def test_add_method_overridden - util_multi_store - - out = doc - - @driver.add_method out, 'Bar#override' - - expected = - doc( - head(1, 'Bar#override'), - blank_line, - para("(from #{@store2.path})"), - rule(1), - blank_line, - para('must be displayed'), - blank_line, - blank_line) - - assert_equal expected, out - end - - def test_add_method_documentation - util_store - - out = doc() - - missing = RDoc::AnyMethod.new nil, 'missing' - @cFoo.add_method missing - - @driver.add_method_documentation out, @cFoo - - expected = - doc( - head(1, 'Foo#inherit'), - blank_line, - para("(from #{@rdoc_home})"), - rule(1), - blank_line, - blank_line, - head(1, 'Foo#override'), - blank_line, - para("(from #{@rdoc_home})"), - rule(1), - blank_line, - para('must not be displayed in Bar#override'), - blank_line, - blank_line) - - assert_equal expected, out - end - - def test_add_method_list - out = @RM::Document.new - - @driver.add_method_list out, %w[new parse], 'Class methods' - - expected = @RM::Document.new( - @RM::Heading.new(1, 'Class methods:'), - @RM::BlankLine.new, - @RM::Verbatim.new('new'), - @RM::Verbatim.new('parse'), - @RM::BlankLine.new) - - assert_equal expected, out - end - - def test_output_width - @options[:width] = 10 - driver = RDoc::RI::Driver.new @options - - doc = @RM::Document.new - doc << @RM::IndentedParagraph.new(0, 'new, parse, foo, bar, baz') - - out, = capture_output do - driver.display doc - end - - expected = "new, parse, foo,\nbar, baz\n" - - assert_equal expected, out - end - - def test_add_method_list_interative - @options[:interactive] = true - driver = RDoc::RI::Driver.new @options - - out = @RM::Document.new - - driver.add_method_list out, %w[new parse], 'Class methods' - - expected = @RM::Document.new( - @RM::Heading.new(1, 'Class methods:'), - @RM::BlankLine.new, - @RM::IndentedParagraph.new(2, 'new, parse'), - @RM::BlankLine.new) - - assert_equal expected, out - end - - def test_add_method_list_none - out = @RM::Document.new - - @driver.add_method_list out, [], 'Class' - - assert_equal @RM::Document.new, out - end - - def test_ancestors_of - util_ancestors_store - - assert_equal %w[X Mixin Object Foo], @driver.ancestors_of('Foo::Bar') - end - - def test_ancestors_of_chained_inclusion - # Store represents something like: - # - # module X - # end - # - # module Y - # include X - # end - # - # class Z - # include Y - # end - # - # Y is not chosen randomly, it has to be after Object in the alphabet - # to reproduce https://github.com/ruby/rdoc/issues/814. - store = RDoc::RI::Store.new @home_ri - store.cache[:ancestors] = { "Z" => ["Object", "Y"], "Y" => ["X"] } - store.cache[:modules] = %W[X Y Z] - @driver.stores = [store] - - assert_equal %w[X Y Object], @driver.ancestors_of('Z') - end - - def test_classes - util_multi_store - - expected = { - 'Ambiguous' => [@store1, @store2], - 'Bar' => [@store2], - 'Ext' => [@store1], - 'Foo' => [@store1, @store2], - 'Foo::Bar' => [@store1], - 'Foo::Baz' => [@store1, @store2], - 'Inc' => [@store1], - 'Qux' => [@store1], - } - - classes = @driver.classes - - assert_equal expected.keys.sort, classes.keys.sort - - expected.each do |klass, stores| - assert_equal stores, classes[klass].sort_by { |store| store.path }, - "mismatch for #{klass}" - end - end - - def test_class_document - util_store - - tl1 = @store1.add_file 'one.rb' - tl2 = @store1.add_file 'two.rb' - - @cFoo.add_comment 'one', tl1 - @cFoo.add_comment 'two', tl2 - - @store1.save_class @cFoo - - found = [ - [@store1, @store1.load_class(@cFoo.full_name)] - ] - - extends = [[[@cFooExt], @store1]] - includes = [[[@cFooInc], @store1]] - - out = @driver.class_document @cFoo.full_name, found, [], includes, extends - - expected = @RM::Document.new - @driver.add_class expected, 'Foo', [] - @driver.add_includes expected, includes - @driver.add_extends expected, extends - @driver.add_from expected, @store1 - expected << @RM::Rule.new(1) - - doc = @RM::Document.new(@RM::Paragraph.new('one')) - doc.file = 'one.rb' - expected.push doc - expected << @RM::BlankLine.new - doc = @RM::Document.new(@RM::Paragraph.new('two')) - doc.file = 'two.rb' - expected.push doc - - expected << @RM::Rule.new(1) - expected << @RM::Heading.new(1, 'Instance methods:') - expected << @RM::BlankLine.new - expected << @RM::Verbatim.new('inherit') - expected << @RM::Verbatim.new('override') - expected << @RM::BlankLine.new - - assert_equal expected, out - end - - def test_complete - store = RDoc::RI::Store.new @home_ri - store.cache[:ancestors] = { - 'Foo' => %w[Object], - 'Foo::Bar' => %w[Object], - } - store.cache[:class_methods] = { - 'Foo' => %w[bar] - } - store.cache[:instance_methods] = { - 'Foo' => %w[Bar] - } - store.cache[:modules] = %w[ - Foo - Foo::Bar - ] - - @driver.stores = [store] - - assert_equal %w[Foo ], @driver.complete('F') - assert_equal %w[ Foo::Bar], @driver.complete('Foo::B') - - assert_equal %w[Foo#Bar], @driver.complete('Foo#'), 'Foo#' - assert_equal %w[Foo#Bar Foo::bar], @driver.complete('Foo.'), 'Foo.' - assert_equal %w[Foo::Bar Foo::bar], @driver.complete('Foo::'), 'Foo::' - - assert_equal %w[ Foo::bar], @driver.complete('Foo::b'), 'Foo::b' - end - - def test_complete_ancestor - util_ancestors_store - - assert_equal %w[Foo::Bar#i_method], @driver.complete('Foo::Bar#') - - assert_equal %w[Foo::Bar#i_method Foo::Bar::c_method Foo::Bar::new], - @driver.complete('Foo::Bar.') - end - - def test_complete_classes - util_store - - assert_equal %w[ ], @driver.complete('[') - assert_equal %w[ ], @driver.complete('[::') - assert_equal %w[Foo ], @driver.complete('F') - assert_equal %w[Foo:: Foo::Bar Foo::Baz], @driver.complete('Foo::') - assert_equal %w[ Foo::Bar Foo::Baz], @driver.complete('Foo::B') - end - - def test_complete_multistore - util_multi_store - - assert_equal %w[Bar], @driver.complete('B') - assert_equal %w[Foo], @driver.complete('F') - assert_equal %w[Foo::Bar Foo::Baz], @driver.complete('Foo::B') - end - - def test_display - doc = @RM::Document.new( - @RM::Paragraph.new('hi')) - - out, = capture_output do - @driver.display doc - end - - assert_equal "hi\n", out - end - - def test_display_class - util_store - - out, = capture_output do - @driver.display_class 'Foo::Bar' - end - - assert_match %r%^= Foo::Bar%, out - assert_match %r%^\(from%, out - - assert_match %r%^= Class methods:%, out - assert_match %r%^ new%, out - assert_match %r%^= Instance methods:%, out - assert_match %r%^ blah%, out - assert_match %r%^= Attributes:%, out - assert_match %r%^ attr_accessor attr%, out - - assert_equal 2, out.scan(/^-{50,}$/).length, out - - refute_match %r%Foo::Bar#blah%, out - end - - def test_display_class_all - util_store - - @driver.show_all = true - - out, = capture_output do - @driver.display_class 'Foo::Bar' - end - - assert_match %r%^= Foo::Bar%, out - assert_match %r%^\(from%, out - - assert_match %r%^= Class methods:%, out - assert_match %r%^ new%, out - assert_match %r%^= Instance methods:%, out - assert_match %r%^ blah%, out - assert_match %r%^= Attributes:%, out - assert_match %r%^ attr_accessor attr%, out - - assert_equal 9, out.scan(/^-{50,}$/).length, out - - assert_match %r%Foo::Bar#blah%, out - assert_match %r%Foo::Bar#blah_with_rdoc_ref%, out - # From Foo::Bar and Foo::Bar#blah_with_rdoc_ref - assert_equal 2, out.scan(/rdoc-ref:README.rdoc/).length - # But README.rdoc should only be displayed once - assert_equal 1, out.scan(/Expanded from README.rdoc/).length - end - - def test_rdoc_refs_expansion_can_be_disabled - util_store - - @driver.instance_variable_set :@expand_rdoc_refs, false - - out, = capture_output do - @driver.display_class 'Foo::Bar' - end - - # From Foo::Bar - assert_equal 1, out.scan(/rdoc-ref:README.rdoc/).length - # But README.rdoc should not be expanded - assert_empty out.scan(/Expanded from README.rdoc/) - end - - def test_display_class_ambiguous - util_multi_store - - out, = capture_output do - @driver.display_class 'Ambiguous' - end - - assert_match %r%^= Ambiguous < Object$%, out - end - - def test_display_class_multi_no_doc - util_multi_store - - out, = capture_output do - @driver.display_class 'Foo::Baz' - end - - assert_match %r%^= Foo::Baz%, out - assert_match %r%-\n%, out - assert_match %r%Also found in:%, out - assert_match %r%#{Regexp.escape @home_ri}%, out - assert_match %r%#{Regexp.escape @home_ri2}%, out - end - - def test_display_class_superclass - util_multi_store - - out, = capture_output do - @driver.display_class 'Bar' - end - - assert_match %r%^= Bar < Foo%, out - end - - def test_display_class_module - util_store - - out, = capture_output do - @driver.display_class 'Inc' - end - - assert_match %r%^= Inc$%, out - end - - def test_display_class_page - out, = capture_output do - @driver.display_class 'ruby:README' - end - - assert_empty out - end - - def test_display_method - util_store - - out, = capture_output do - @driver.display_method 'Foo::Bar#blah' - end - - assert_match %r%Foo::Bar#blah%, out - assert_match %r%blah.5%, out - assert_match %r%blah.6%, out - end - - def test_display_method_attribute - util_store - - out, = capture_output do - @driver.display_method 'Foo::Bar#attr' - end - - assert_match %r%Foo::Bar#attr%, out - refute_match %r%Implementation from%, out - end - - def test_display_method_inherited - util_multi_store - - out, = capture_output do - @driver.display_method 'Bar#inherit' - end - - assert_match %r%^= Bar#inherit%, out - assert_match %r%^=== Implementation from Foo%, out - end - - def test_display_method_overridden - util_multi_store - - out, = capture_output do - @driver.display_method 'Bar#override' - end - - refute_match %r%must not be displayed%, out - end - - def test_display_name - util_store - - out, = capture_output do - assert_equal true, @driver.display_name('home:README.rdoc') - end - - expected = <<-EXPECTED -= README -This is a README - EXPECTED - - assert_equal expected, out - end - - def test_display_name_not_found_class - util_store - - out, = capture_output do - assert_equal false, @driver.display_name('Foo::B') - end - - expected = <<-EXPECTED -Foo::B not found, maybe you meant: - -Foo::Bar -Foo::Baz - EXPECTED - - assert_equal expected, out - end - - def test_display_name_not_found_method - util_store - - out, = capture_output do - assert_equal false, @driver.display_name('Foo::Bar#b') - end - - expected = <<-EXPECTED -Foo::Bar#b not found, maybe you meant: - -Foo::Bar#blah -Foo::Bar#blah_with_rdoc_ref -Foo::Bar#bother - EXPECTED - - assert_equal expected, out - end - - def test_display_name_not_found_special - util_store - - assert_raise RDoc::RI::Driver::NotFoundError do - assert_equal false, @driver.display_name('Set#[]') - end - end - - def test_display_method_params - util_store - - out, = capture_output do - @driver.display_method 'Foo::Bar#bother' - end - - assert_match %r%things.*stuff%, out - end - - def test_display_page - util_store - - out, = capture_output do - @driver.display_page 'home:README.rdoc' - end - - assert_match %r%= README%, out - end - - def test_display_page_add_extension - util_store - - out, = capture_output do - @driver.display_page 'home:README' - end - - assert_match %r%= README%, out - end - - def test_display_page_ambiguous - util_store - - other = @store1.add_file 'README.md' - other.parser = RDoc::Parser::Simple - other.comment = - doc( - head(1, 'README.md'), - para('This is the other README')) - - @store1.save_page other - - out, = capture_output do - @driver.display_page 'home:README' - end - - assert_match %r%= README pages in #{@rdoc_home}%, out - assert_match %r%README\.rdoc%, out - assert_match %r%README\.md%, out - end - - def test_display_page_extension - util_store - - other = @store1.add_file 'README.EXT' - other.parser = RDoc::Parser::Simple - other.comment = - doc( - head(1, 'README.EXT'), - para('This is the other README')) - - @store1.save_page other - - out, = capture_output do - @driver.display_page 'home:README.EXT' - end - - assert_match 'other README', out - end - - def test_display_page_ignore_directory - util_store - - other = @store1.add_file 'doc/globals.rdoc' - other.parser = RDoc::Parser::Simple - other.comment = - doc( - head(1, 'globals.rdoc'), - para('Globals go here')) - - @store1.save_page other - - out, = capture_output do - @driver.display_page 'home:globals' - end - - assert_match %r%= globals\.rdoc%, out - end - - def test_display_page_missing - util_store - - out, = capture_output do - @driver.display_page 'home:missing' - end - - out, = capture_output do - @driver.display_page_list @store1 - end - - assert_match %r%= Pages in #{@rdoc_home}%, out - assert_match %r%README\.rdoc%, out - end - - def test_display_page_list - util_store - - other = @store1.add_file 'OTHER.rdoc' - other.parser = RDoc::Parser::Simple - other.comment = - doc( - head(1, 'OTHER'), - para('This is OTHER')) - - @store1.save_page other - - out, = capture_output do - @driver.display_page_list @store1 - end - - assert_match %r%= Pages in #{@rdoc_home}%, out - assert_match %r%README\.rdoc%, out - assert_match %r%OTHER\.rdoc%, out - end - - def test_expand_class - util_store - - assert_equal 'Foo', @driver.expand_class('F') - assert_equal 'Foo::Bar', @driver.expand_class('F::Bar') - - assert_raise RDoc::RI::Driver::NotFoundError do - @driver.expand_class 'F::B' - end - end - - def test_expand_class_2 - @store1 = RDoc::RI::Store.new @home_ri, :home - - @top_level = @store1.add_file 'file.rb' - - @cFoo = @top_level.add_class RDoc::NormalClass, 'Foo' - @mFox = @top_level.add_module RDoc::NormalModule, 'Fox' - @cFoo_Bar = @cFoo.add_class RDoc::NormalClass, 'Bar' - @store1.save - - @driver.stores = [@store1] - assert_raise RDoc::RI::Driver::NotFoundError do - @driver.expand_class 'F' - end - assert_equal 'Foo::Bar', @driver.expand_class('F::Bar') - assert_equal 'Foo::Bar', @driver.expand_class('F::B') - end - - def test_expand_class_3 - @store1 = RDoc::RI::Store.new @home_ri, :home - - @top_level = @store1.add_file 'file.rb' - - @cFoo = @top_level.add_class RDoc::NormalClass, 'Foo' - @mFox = @top_level.add_module RDoc::NormalModule, 'FooBar' - @store1.save - - @driver.stores = [@store1] - - assert_equal 'Foo', @driver.expand_class('Foo') - end - - def test_expand_name - util_store - - assert_equal '.b', @driver.expand_name('b') - assert_equal 'Foo', @driver.expand_name('F') - assert_equal 'Foo::Bar#', @driver.expand_name('F::Bar#') - - e = assert_raise RDoc::RI::Driver::NotFoundError do - @driver.expand_name 'Z' - end - - assert_equal 'Z', e.name - - @driver.stores << RDoc::Store.new(nil, :system) - - assert_equal 'ruby:README', @driver.expand_name('ruby:README') - assert_equal 'ruby:', @driver.expand_name('ruby:') - - e = assert_raise RDoc::RI::Driver::NotFoundError do - @driver.expand_name 'nonexistent_gem:' - end - - assert_equal 'nonexistent_gem', e.name - end - - def test_find_methods - util_store - - items = [] - - @driver.find_methods 'Foo::Bar.' do |store, klass, ancestor, types, method| - items << [store, klass, ancestor, types, method] - end - - expected = [ - [@store1, 'Foo::Bar', 'Foo::Bar', :both, nil], - ] - - assert_equal expected, items - end - - def test_find_methods_method - util_store - - items = [] - - @driver.find_methods '.blah' do |store, klass, ancestor, types, method| - items << [store, klass, ancestor, types, method] - end - - expected = [ - [@store1, 'Ambiguous', 'Ambiguous', :both, 'blah'], - [@store1, 'Ext', 'Ext', :both, 'blah'], - [@store1, 'Foo', 'Foo', :both, 'blah'], - [@store1, 'Foo::Bar', 'Foo::Bar', :both, 'blah'], - [@store1, 'Foo::Baz', 'Foo::Baz', :both, 'blah'], - [@store1, 'Inc', 'Inc', :both, 'blah'], - [@store1, 'Qux', 'Qux', :both, 'blah'], - ] - - assert_equal expected, items - end - - def test_filter_methods - util_multi_store - - name = 'Bar#override' - - found = @driver.load_methods_matching name - - sorted = @driver.filter_methods found, name - - expected = [[@store2, [@override]]] - - assert_equal expected, sorted - end - - def test_filter_methods_not_found - util_multi_store - - name = 'Bar#inherit' - - found = @driver.load_methods_matching name - - sorted = @driver.filter_methods found, name - - assert_equal found, sorted - end - - def test_find_store - @driver.stores << RDoc::Store.new(nil, :system) - @driver.stores << RDoc::Store.new('doc/gem-1.0/ri', :gem) - - assert_equal 'ruby', @driver.find_store('ruby') - assert_equal 'gem-1.0', @driver.find_store('gem-1.0') - assert_equal 'gem-1.0', @driver.find_store('gem') - - e = assert_raise RDoc::RI::Driver::NotFoundError do - @driver.find_store 'nonexistent' - end - - assert_equal 'nonexistent', e.name - end - - def test_did_you_mean - omit 'skip test with did_you_men' unless defined? DidYouMean::SpellChecker - - util_ancestors_store - - e = assert_raise RDoc::RI::Driver::NotFoundError do - @driver.lookup_method 'Foo.i_methdo' - end - assert_equal "Nothing known about Foo.i_methdo\nDid you mean? i_method", e.message - - e = assert_raise RDoc::RI::Driver::NotFoundError do - @driver.lookup_method 'Foo#i_methdo' - end - assert_equal "Nothing known about Foo#i_methdo\nDid you mean? i_method", e.message - - e = assert_raise RDoc::RI::Driver::NotFoundError do - @driver.lookup_method 'Foo::i_methdo' - end - assert_equal "Nothing known about Foo::i_methdo\nDid you mean? c_method", e.message - end - - def test_formatter - tty = Object.new - def tty.tty?() true; end - - @options.delete :use_stdout - @options.delete :formatter - - driver = RDoc::RI::Driver.new @options - - assert_instance_of @RM::ToAnsi, driver.formatter(tty) - - assert_instance_of @RM::ToBs, driver.formatter(StringIO.new) - - driver.instance_variable_set :@paging, true - - assert_instance_of @RM::ToBs, driver.formatter(StringIO.new) - end - - def test_method_type - assert_equal :both, @driver.method_type(nil) - assert_equal :both, @driver.method_type('.') - assert_equal :instance, @driver.method_type('#') - assert_equal :class, @driver.method_type('::') - end - - def test_name_regexp - assert_equal %r%^RDoc::AnyMethod#new$%, - @driver.name_regexp('RDoc::AnyMethod#new') - - assert_equal %r%^RDoc::AnyMethod::new$%, - @driver.name_regexp('RDoc::AnyMethod::new') - - assert_equal %r%^RDoc::AnyMethod(#|::)new$%, - @driver.name_regexp('RDoc::AnyMethod.new') - - assert_equal %r%^Hash(#|::)\[\]$%, - @driver.name_regexp('Hash.[]') - - assert_equal %r%^Hash::\[\]$%, - @driver.name_regexp('Hash::[]') - end - - def test_list_known_classes - util_store - - out, = capture_output do - @driver.list_known_classes - end - - assert_equal "Ambiguous\nExt\nFoo\nFoo::Bar\nFoo::Baz\nInc\nQux\n", out - end - - def test_list_known_classes_name - util_store - - out, = capture_output do - @driver.list_known_classes %w[F I] - end - - assert_equal "Foo\nFoo::Bar\nFoo::Baz\nInc\n", out - end - - def test_list_methods_matching - util_store - - assert_equal %w[ - Foo::Bar#attr - Foo::Bar#blah - Foo::Bar#blah_with_rdoc_ref - Foo::Bar#bother - Foo::Bar::new - ], - @driver.list_methods_matching('Foo::Bar.').sort - end - - def test_list_methods_matching_inherit - util_multi_store - - assert_equal %w[ - Bar#baz - Bar#inherit - Bar#override - ], - @driver.list_methods_matching('Bar.').sort - end - - def test_list_methods_matching_regexp - util_store - - index = RDoc::AnyMethod.new nil, '[]' - index.record_location @top_level - @cFoo.add_method index - @store1.save_method @cFoo, index - - c_index = RDoc::AnyMethod.new nil, '[]' - c_index.singleton = true - c_index.record_location @top_level - @cFoo.add_method c_index - @store1.save_method @cFoo, c_index - - @store1.save_cache - - assert_equal %w[Foo#[]], @driver.list_methods_matching('Foo#[]') - assert_equal %w[Foo::[]], @driver.list_methods_matching('Foo::[]') - end - - def test_load_method - util_store - - method = @driver.load_method(@store1, :instance_methods, 'Foo', '#', - 'inherit') - - assert_equal @inherit, method - end - - def test_load_method_inherited - util_multi_store - - method = @driver.load_method(@store2, :instance_methods, 'Bar', '#', - 'inherit') - - assert_nil method - end - - def test_load_methods_matching - util_store - - expected = [[@store1, [@inherit]]] - - assert_equal expected, @driver.load_methods_matching('Foo#inherit') - - expected = [[@store1, [@blah]]] - - assert_equal expected, @driver.load_methods_matching('.blah') - - assert_empty @driver.load_methods_matching('.b') - end - - def test_load_methods_matching_inherited - util_multi_store - - expected = [[@store1, [@inherit]]] - - assert_equal expected, @driver.load_methods_matching('Bar#inherit') - end - - def test_load_method_missing - util_store - - FileUtils.rm @store1.method_file 'Foo', '#inherit' - - method = @driver.load_method(@store1, :instance_methods, 'Foo', '#', - 'inherit') - - assert_equal '(unknown)#inherit', method.full_name - end - - def test_page - @driver.use_stdout = false - - with_dummy_pager do - @driver.page do |io| - omit "couldn't find a standard pager" if io == $stdout - - assert @driver.paging? - end - end - - refute @driver.paging? - end - - def test_page_in_presence_of_child_status - @driver.use_stdout = false - - with_dummy_pager do - @driver.page do |io| - refute_equal $stdout, io - assert @driver.paging? - end - end - end - - def test_page_stdout - @driver.use_stdout = true - - @driver.page do |io| - assert_equal $stdout, io - end - - refute @driver.paging? - end - - def test_parse_name_method - klass, type, meth = @driver.parse_name 'foo' - - assert_equal '', klass, 'foo class' - assert_equal '.', type, 'foo type' - assert_equal 'foo', meth, 'foo method' - - klass, type, meth = @driver.parse_name '#foo' - - assert_equal '', klass, '#foo class' - assert_equal '#', type, '#foo type' - assert_equal 'foo', meth, '#foo method' - - klass, type, meth = @driver.parse_name '::foo' - - assert_equal '', klass, '::foo class' - assert_equal '::', type, '::foo type' - assert_equal 'foo', meth, '::foo method' - end - - def test_parse_name_page - klass, type, meth = @driver.parse_name 'ruby:README' - - assert_equal 'ruby', klass, 'ruby project' - assert_equal ':', type, 'ruby type' - assert_equal 'README', meth, 'ruby page' - - klass, type, meth = @driver.parse_name 'ruby:' - - assert_equal 'ruby', klass, 'ruby project' - assert_equal ':', type, 'ruby type' - assert_nil meth, 'ruby page' - end - - def test_parse_name_page_extenson - klass, type, meth = @driver.parse_name 'ruby:README.EXT' - - assert_equal 'ruby', klass, 'ruby project' - assert_equal ':', type, 'ruby type' - assert_equal 'README.EXT', meth, 'ruby page' - end - - def test_parse_name_single_class - klass, type, meth = @driver.parse_name 'Foo' - - assert_equal 'Foo', klass, 'Foo class' - assert_nil type, 'Foo type' - assert_nil meth, 'Foo method' - - klass, type, meth = @driver.parse_name 'Foo#' - - assert_equal 'Foo', klass, 'Foo# class' - assert_equal '#', type, 'Foo# type' - assert_nil meth, 'Foo# method' - - klass, type, meth = @driver.parse_name 'Foo::' - - assert_equal 'Foo', klass, 'Foo:: class' - assert_equal '::', type, 'Foo:: type' - assert_nil meth, 'Foo:: method' - - klass, type, meth = @driver.parse_name 'Foo.' - - assert_equal 'Foo', klass, 'Foo. class' - assert_equal '.', type, 'Foo. type' - assert_nil meth, 'Foo. method' - - klass, type, meth = @driver.parse_name 'Foo#Bar' - - assert_equal 'Foo', klass, 'Foo#Bar class' - assert_equal '#', type, 'Foo#Bar type' - assert_equal 'Bar', meth, 'Foo#Bar method' - - klass, type, meth = @driver.parse_name 'Foo.Bar' - - assert_equal 'Foo', klass, 'Foo.Bar class' - assert_equal '.', type, 'Foo.Bar type' - assert_equal 'Bar', meth, 'Foo.Bar method' - - klass, type, meth = @driver.parse_name 'Foo::bar' - - assert_equal 'Foo', klass, 'Foo::bar class' - assert_equal '::', type, 'Foo::bar type' - assert_equal 'bar', meth, 'Foo::bar method' - end - - def test_parse_name_namespace - klass, type, meth = @driver.parse_name 'Foo::Bar' - - assert_equal 'Foo::Bar', klass, 'Foo::Bar class' - assert_nil type, 'Foo::Bar type' - assert_nil meth, 'Foo::Bar method' - - klass, type, meth = @driver.parse_name 'Foo::Bar#' - - assert_equal 'Foo::Bar', klass, 'Foo::Bar# class' - assert_equal '#', type, 'Foo::Bar# type' - assert_nil meth, 'Foo::Bar# method' - - klass, type, meth = @driver.parse_name 'Foo::Bar#baz' - - assert_equal 'Foo::Bar', klass, 'Foo::Bar#baz class' - assert_equal '#', type, 'Foo::Bar#baz type' - assert_equal 'baz', meth, 'Foo::Bar#baz method' - end - - def test_parse_name_special - specials = %w[ - % - & - * - + - +@ - - - -@ - / - < - << - <= - <=> - == - === - => - =~ - > - >> - [] - []= - ^ - ` - | - ~ - ~@ - ] - - specials.each do |special| - parsed = @driver.parse_name special - - assert_equal ['', '.', special], parsed - end - end - - def test_setup_pager # this test doesn't do anything anymore :( - @driver.use_stdout = false - - pager = with_dummy_pager do @driver.setup_pager end - - omit "couldn't find a standard pager" unless pager - - assert @driver.paging? - ensure - pager.close if pager - end - - def util_ancestors_store - store1 = RDoc::RI::Store.new @home_ri - store1.cache[:ancestors] = { - 'Foo' => %w[Object], - 'Foo::Bar' => %w[Foo], - } - store1.cache[:class_methods] = { - 'Foo' => %w[c_method new], - 'Foo::Bar' => %w[new], - } - store1.cache[:instance_methods] = { - 'Foo' => %w[i_method], - } - store1.cache[:modules] = %w[ - Foo - Foo::Bar - ] - - store2 = RDoc::RI::Store.new @home_ri - store2.cache[:ancestors] = { - 'Foo' => %w[Mixin Object], - 'Mixin' => %w[], - 'Object' => %w[X Object], - 'X' => %w[Object], - } - store2.cache[:class_methods] = { - 'Foo' => %w[c_method new], - 'Mixin' => %w[], - 'X' => %w[], - 'Object' => %w[], - } - store2.cache[:instance_methods] = { - 'Foo' => %w[i_method], - 'Mixin' => %w[], - } - store2.cache[:modules] = %w[ - Foo - Mixin - Object - X - ] - - @driver.stores = store1, store2 - end - - def util_multi_store - util_store - - @home_ri2 = "#{@home_ri}2" - @store2 = RDoc::RI::Store.new @home_ri2 - - @top_level = @store2.add_file 'file.rb' - - # as if seen in a namespace like class Ambiguous::Other - @mAmbiguous = @top_level.add_module RDoc::NormalModule, 'Ambiguous' - - @cFoo = @top_level.add_class RDoc::NormalClass, 'Foo' - - @cBar = @top_level.add_class RDoc::NormalClass, 'Bar', 'Foo' - @cFoo_Baz = @cFoo.add_class RDoc::NormalClass, 'Baz' - - @baz = @cBar.add_method RDoc::AnyMethod.new(nil, 'baz') - @baz.record_location @top_level - - @override = @cBar.add_method RDoc::AnyMethod.new(nil, 'override') - @override.comment = 'must be displayed' - @override.record_location @top_level - - @store2.save - - @driver.stores = [@store1, @store2] - end - - def util_store - @store1 = RDoc::RI::Store.new @home_ri, :home - - @top_level = @store1.add_file 'file.rb' - - @readme = @store1.add_file 'README.rdoc' - @readme.parser = RDoc::Parser::Simple - @readme.comment = - doc( - head(1, 'README'), - para('This is a README')) - - @cFoo = @top_level.add_class RDoc::NormalClass, 'Foo' - @mExt = @top_level.add_module RDoc::NormalModule, 'Ext' - @mInc = @top_level.add_module RDoc::NormalModule, 'Inc' - @cAmbiguous = @top_level.add_class RDoc::NormalClass, 'Ambiguous' - - doc = @RM::Document.new @RM::Paragraph.new('Extend thingy') - @cFooExt = @cFoo.add_extend RDoc::Extend.new('Ext', doc) - @cFooExt.record_location @top_level - doc = @RM::Document.new @RM::Paragraph.new('Include thingy') - @cFooInc = @cFoo.add_include RDoc::Include.new('Inc', doc) - @cFooInc.record_location @top_level - - @cFoo_Bar = @cFoo.add_class RDoc::NormalClass, 'Bar' - @cFoo_Bar.add_comment "See also {Doc}[rdoc-ref:README.rdoc]", @top_level - @cFoo_Bar.record_location @top_level - - @blah = @cFoo_Bar.add_method RDoc::AnyMethod.new(nil, 'blah') - @blah.call_seq = "blah(5) => 5\nblah(6) => 6\n" - @blah.record_location @top_level - - @blah_with_rdoc_ref = @cFoo_Bar.add_method RDoc::AnyMethod.new(nil, 'blah_with_rdoc_ref') - @blah_with_rdoc_ref.call_seq = "blah(5) => 5\nSee also {Doc}[rdoc-ref:README.rdoc]" - @blah_with_rdoc_ref.record_location @top_level - - @bother = @cFoo_Bar.add_method RDoc::AnyMethod.new(nil, 'bother') - @bother.block_params = "stuff" - @bother.params = "(things)" - @bother.record_location @top_level - - @new = @cFoo_Bar.add_method RDoc::AnyMethod.new nil, 'new' - @new.record_location @top_level - @new.singleton = true - - @attr = @cFoo_Bar.add_attribute RDoc::Attr.new nil, 'attr', 'RW', '' - @attr.record_location @top_level - - @cFoo_Baz = @cFoo.add_class RDoc::NormalClass, 'Baz' - @cFoo_Baz.record_location @top_level - - @inherit = @cFoo.add_method RDoc::AnyMethod.new(nil, 'inherit') - @inherit.record_location @top_level - - # overridden by Bar in multi_store - @overridden = @cFoo.add_method RDoc::AnyMethod.new(nil, 'override') - @overridden.comment = 'must not be displayed in Bar#override' - @overridden.record_location @top_level - - @cQux = @top_level.add_class RDoc::NormalClass, 'Qux' - - @original = @cQux.add_method RDoc::AnyMethod.new(nil, 'original') - @original.comment = 'original comment' - @original.record_location @top_level - - @aliased = @original.add_alias RDoc::Alias.new(nil, 'original', 'aliased', 'alias comment'), @cQux - @aliased.record_location @top_level - - @store1.save - - @driver.stores = [@store1] - end - -end diff --git a/test/rdoc/test_rdoc_ri_paths.rb b/test/rdoc/test_rdoc_ri_paths.rb deleted file mode 100644 index 6dccd6dbdd..0000000000 --- a/test/rdoc/test_rdoc_ri_paths.rb +++ /dev/null @@ -1,157 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocRIPaths < RDoc::TestCase - - def setup - super - - @orig_env = ENV.to_hash - @orig_gem_path = Gem.path - - @tempdir = File.join Dir.tmpdir, "test_rdoc_ri_paths_#{$$}" - Gem.use_paths @tempdir - Gem.ensure_gem_subdirectories @tempdir - - specs = [ - @rake_10 = Gem::Specification.new('rake', '10.0.1'), - @rdoc_4_0 = Gem::Specification.new('rdoc', '4.0'), - @rdoc_3_12 = Gem::Specification.new('rdoc', '3.12'), - @nodoc = Gem::Specification.new('nodoc', '1.0'), - ] - - specs.each do |spec| - spec.loaded_from = spec.spec_file - - File.open spec.spec_file, 'w' do |file| - file.write spec.to_ruby_for_cache - end - - FileUtils.mkdir_p File.join(spec.doc_dir, 'ri') unless - spec.name == 'nodoc' - end - - Gem::Specification.reset - Gem::Specification.all = specs - end - - def teardown - Gem.use_paths(*@orig_gem_path) - Gem::Specification.reset - FileUtils.rm_rf @tempdir - ENV.replace(@orig_env) - - super - end - - def test_class_each - enum = RDoc::RI::Paths.each true, true, true, :all - - path = enum.map { |dir,| dir } - - assert_equal RDoc::RI::Paths.system_dir, path.shift - assert_equal RDoc::RI::Paths.site_dir, path.shift - assert_equal RDoc::RI::Paths.home_dir, path.shift if RDoc::RI::Paths.home_dir - assert_equal File.join(@nodoc.doc_dir, 'ri'), path.shift - assert_equal File.join(@rake_10.doc_dir, 'ri'), path.shift - assert_equal File.join(@rdoc_4_0.doc_dir, 'ri'), path.shift - assert_equal File.join(@rdoc_3_12.doc_dir, 'ri'), path.shift - assert_empty path - end - - def test_class_gemdirs_latest - Dir.chdir @tempdir do - gemdirs = RDoc::RI::Paths.gemdirs :latest - - expected = [ - File.join(@rake_10.doc_dir, 'ri'), - File.join(@rdoc_4_0.doc_dir, 'ri'), - ] - - assert_equal expected, gemdirs - end - end - - def test_class_gemdirs_legacy - Dir.chdir @tempdir do - gemdirs = RDoc::RI::Paths.gemdirs true - - expected = [ - File.join(@rake_10.doc_dir, 'ri'), - File.join(@rdoc_4_0.doc_dir, 'ri'), - ] - - assert_equal expected, gemdirs - end - end - - def test_class_gemdirs_all - Dir.chdir @tempdir do - gemdirs = RDoc::RI::Paths.gemdirs :all - - expected = [ - File.join(@nodoc.doc_dir, 'ri'), - File.join(@rake_10.doc_dir, 'ri'), - File.join(@rdoc_4_0.doc_dir, 'ri'), - File.join(@rdoc_3_12.doc_dir, 'ri'), - ] - - assert_equal expected, gemdirs - end - end - - def test_class_gem_dir - dir = RDoc::RI::Paths.gem_dir 'rake', '10.0.1' - - expected = File.join @rake_10.doc_dir, 'ri' - - assert_equal expected, dir - end - - def test_class_home_dir - dir = RDoc::RI::Paths.home_dir - - assert_equal RDoc::RI::Paths::HOMEDIR, dir - end - - def test_class_path_nonexistent - temp_dir do |dir| - nonexistent = File.join dir, 'nonexistent' - dir = RDoc::RI::Paths.path true, true, true, true, nonexistent - - refute_includes dir, nonexistent - end - end - - def test_class_raw_path - path = RDoc::RI::Paths.raw_path true, true, true, true - - assert_equal RDoc::RI::Paths.system_dir, path.shift - assert_equal RDoc::RI::Paths.site_dir, path.shift - assert_equal RDoc::RI::Paths.home_dir, path.shift if RDoc::RI::Paths.home_dir - assert_equal File.join(@rake_10.doc_dir, 'ri'), path.shift - end - - def test_class_raw_path_extra_dirs - path = RDoc::RI::Paths.raw_path true, true, true, true, '/nonexistent' - - assert_equal '/nonexistent', path.shift - assert_equal RDoc::RI::Paths.system_dir, path.shift - assert_equal RDoc::RI::Paths.site_dir, path.shift - assert_equal RDoc::RI::Paths.home_dir, path.shift if RDoc::RI::Paths.home_dir - assert_equal File.join(@rake_10.doc_dir, 'ri'), path.shift - end - - def test_class_site_dir - dir = RDoc::RI::Paths.site_dir - - assert_equal File.join(RDoc::RI::Paths::BASE, 'site'), dir - end - - def test_class_system_dir - dir = RDoc::RI::Paths.system_dir - - assert_equal File.join(RDoc::RI::Paths::BASE, 'system'), dir - end - -end diff --git a/test/rdoc/test_rdoc_rubygems_hook.rb b/test/rdoc/test_rdoc_rubygems_hook.rb deleted file mode 100644 index b16f8e3385..0000000000 --- a/test/rdoc/test_rdoc_rubygems_hook.rb +++ /dev/null @@ -1,317 +0,0 @@ -# frozen_string_literal: true -require 'rubygems' -require 'fileutils' -require 'tmpdir' -require_relative '../../lib/rdoc/rubygems_hook' -require 'test/unit' - -class TestRDocRubyGemsHook < Test::Unit::TestCase - def setup - @a = Gem::Specification.new do |s| - s.platform = Gem::Platform::RUBY - s.name = "a" - s.version = 2 - s.rdoc_options = %w[--main MyTitle] - s.extra_rdoc_files = %w[README] - end - @tempdir = File.realpath(Dir.mktmpdir("test_rubygems_hook_")) - - @orig_envs = %w[ - GEM_VENDOR - GEMRC - XDG_CACHE_HOME - XDG_CONFIG_HOME - XDG_DATA_HOME - SOURCE_DATE_EPOCH - BUNDLER_VERSION - HOME - RDOCOPT - ].map {|e| [e, ENV.delete(e)]}.to_h - ENV["HOME"] = @tempdir - - Gem.configuration = nil - - @a.instance_variable_set(:@doc_dir, File.join(@tempdir, "doc")) - @a.instance_variable_set(:@gem_dir, File.join(@tempdir, "a-2")) - @a.instance_variable_set(:@full_gem_path, File.join(@tempdir, "a-2")) - @a.loaded_from = File.join(@tempdir, 'a-2', 'a-2.gemspec') - - FileUtils.mkdir_p File.join(@tempdir, 'a-2', 'lib') - FileUtils.touch File.join(@tempdir, 'a-2', 'README') - File.open(File.join(@tempdir, 'a-2', 'lib', 'a.rb'), 'w') do |f| - f.puts '# comment' - f.puts '# :include: include.txt' - f.puts 'class A; end' - end - File.open(File.join(@tempdir, 'a-2', 'include.txt'), 'w') do |f| - f.puts 'included content' - end - - @hook = RDoc::RubyGemsHook.new @a - - begin - RDoc::RubyGemsHook.load_rdoc - rescue Gem::DocumentError => e - omit e.message - end - @old_ui = Gem::DefaultUserInteraction.ui - Gem::DefaultUserInteraction.ui = Gem::SilentUI.new - end - - def teardown - ui = Gem::DefaultUserInteraction.ui - Gem::DefaultUserInteraction.ui = @old_ui - FileUtils.rm_rf @tempdir - ui.close - ENV.update(@orig_envs) - end - - def test_initialize - refute @hook.generate_rdoc - assert @hook.generate_ri - - rdoc = RDoc::RubyGemsHook.new @a, false, false - - refute rdoc.generate_rdoc - refute rdoc.generate_ri - end - - def test_delete_legacy_args - args = %w[ - --inline-source - --one-file - --promiscuous - -p - ] - - @hook.delete_legacy_args args - - assert_empty args - end - - def test_document - options = RDoc::Options.new - options.files = [] - - rdoc = @hook.new_rdoc - rdoc.store = RDoc::Store.new - @hook.instance_variable_set :@rdoc, rdoc - @hook.instance_variable_set :@file_info, [] - - @hook.document 'darkfish', options, @a.doc_dir('rdoc') - - assert @hook.rdoc_installed? - end - - def test_generate - FileUtils.mkdir_p @a.doc_dir - FileUtils.mkdir_p File.join(@a.gem_dir, 'lib') - - @hook.generate - - refute @hook.rdoc_installed? - assert @hook.ri_installed? - - rdoc = @hook.instance_variable_get :@rdoc - - refute rdoc.options.hyperlink_all - assert_equal Pathname(@a.full_gem_path), rdoc.options.root - assert_equal %w[README lib], rdoc.options.files.sort - - assert_equal 'MyTitle', rdoc.store.main - - klass = rdoc.store.find_class_named('A') - refute_nil klass - assert_includes klass.comment.text, 'included content' - end - - def test_generate_all - @hook.generate_rdoc = true - @hook.generate_ri = true - - FileUtils.mkdir_p @a.doc_dir - FileUtils.mkdir_p File.join(@a.gem_dir, 'lib') - - @hook.generate - - assert @hook.rdoc_installed? - assert @hook.ri_installed? - - rdoc = @hook.instance_variable_get :@rdoc - - refute rdoc.options.hyperlink_all - assert_equal Pathname(@a.full_gem_path), rdoc.options.root - assert_equal %w[README lib], rdoc.options.files.sort - - assert_equal 'MyTitle', rdoc.store.main - end - - def test_generate_configuration_rdoc_array - Gem.configuration[:rdoc] = %w[-A] - - FileUtils.mkdir_p @a.doc_dir - FileUtils.mkdir_p File.join(@a.gem_dir, 'lib') - - @hook.generate - - rdoc = @hook.instance_variable_get :@rdoc - - assert rdoc.options.hyperlink_all - end - - def test_generate_configuration_rdoc_string - Gem.configuration[:rdoc] = '-A' - - FileUtils.mkdir_p @a.doc_dir - FileUtils.mkdir_p File.join(@a.gem_dir, 'lib') - - @hook.generate - - rdoc = @hook.instance_variable_get :@rdoc - - assert rdoc.options.hyperlink_all - end - - def test_generate_default_gem - Gem::Deprecate.skip_during do - if Gem.respond_to?(:default_specifications_dir) - klass = Gem - else - klass = Gem::Specification - end - @a.loaded_from = File.join klass.default_specifications_dir, 'a.gemspec' - end - - @hook.generate - - refute @hook.rdoc_installed? - refute @hook.ri_installed? - end - - def test_generate_disabled - @hook.generate_rdoc = false - @hook.generate_ri = false - - @hook.generate - - refute @hook.rdoc_installed? - refute @hook.ri_installed? - end - - def test_generate_force - FileUtils.mkdir_p @a.doc_dir 'ri' - FileUtils.mkdir_p @a.doc_dir 'rdoc' - FileUtils.mkdir_p File.join(@a.gem_dir, 'lib') - - @hook.force = true - - @hook.generate - - assert_path_not_exist File.join(@a.doc_dir('rdoc'), 'index.html') - assert_path_exist File.join(@a.doc_dir('ri'), 'cache.ri') - end - - def test_generate_rubygems_compatible - original_default_gem_method = RDoc::RubygemsHook.method(:default_gem?) - RDoc::RubygemsHook.singleton_class.remove_method(:default_gem?) - RDoc::RubygemsHook.define_singleton_method(:default_gem?) { true } - FileUtils.mkdir_p @a.doc_dir 'ri' - FileUtils.mkdir_p @a.doc_dir 'rdoc' - FileUtils.mkdir_p File.join(@a.gem_dir, 'lib') - - # rubygems/lib/rubygems/commands/rdoc_command.rb calls this - hook = RDoc::RubygemsHook.new @a, true, true - hook.force = true - hook.generate - - assert_path_exist File.join(@a.doc_dir('rdoc'), 'index.html') - ensure - RDoc::RubygemsHook.singleton_class.remove_method(:default_gem?) - RDoc::RubygemsHook.define_singleton_method(:default_gem?, &original_default_gem_method) - end - - def test_generate_no_overwrite - FileUtils.mkdir_p @a.doc_dir 'ri' - FileUtils.mkdir_p @a.doc_dir 'rdoc' - FileUtils.mkdir_p File.join(@a.gem_dir, 'lib') - - @hook.generate - - assert_path_not_exist File.join(@a.doc_dir('rdoc'), 'index.html') - assert_path_not_exist File.join(@a.doc_dir('ri'), 'cache.ri') - end - - def test_new_rdoc - assert_kind_of RDoc::RDoc, @hook.new_rdoc - end - - def test_rdoc_installed? - refute @hook.rdoc_installed? - - FileUtils.mkdir_p @a.doc_dir 'rdoc' - - assert @hook.rdoc_installed? - end - - def test_remove - FileUtils.mkdir_p @a.doc_dir 'rdoc' - FileUtils.mkdir_p @a.doc_dir 'ri' - - @hook.remove - - refute @hook.rdoc_installed? - refute @hook.ri_installed? - - assert_path_exist @a.doc_dir - end - - def test_remove_unwritable - omit 'chmod not supported' if Gem.win_platform? - omit "assumes that euid is not root" if Process.euid == 0 - - FileUtils.mkdir_p @a.base_dir - FileUtils.chmod 0, @a.base_dir - - e = assert_raise Gem::FilePermissionError do - @hook.remove - end - - assert_equal @a.base_dir, e.directory - ensure - FileUtils.chmod(0755, @a.base_dir) if File.directory?(@a.base_dir) - end - - def test_ri_installed? - refute @hook.ri_installed? - - FileUtils.mkdir_p @a.doc_dir 'ri' - - assert @hook.ri_installed? - end - - def test_setup - @hook.setup - - assert_path_exist @a.doc_dir - end - - def test_setup_unwritable - omit 'chmod not supported' if Gem.win_platform? - omit "assumes that euid is not root" if Process.euid == 0 - - FileUtils.mkdir_p @a.doc_dir - FileUtils.chmod 0, @a.doc_dir - - e = assert_raise Gem::FilePermissionError do - @hook.setup - end - - assert_equal @a.doc_dir, e.directory - ensure - if File.exist? @a.doc_dir - FileUtils.chmod 0755, @a.doc_dir - FileUtils.rm_r @a.doc_dir - end - end - -end diff --git a/test/rdoc/test_rdoc_servlet.rb b/test/rdoc/test_rdoc_servlet.rb deleted file mode 100644 index 7a5b15a6eb..0000000000 --- a/test/rdoc/test_rdoc_servlet.rb +++ /dev/null @@ -1,555 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' -begin - require 'webrick' -rescue LoadError -end - -class TestRDocServlet < RDoc::TestCase - - def setup - super - - @orig_gem_path = Gem.path - - @tempdir = File.join Dir.tmpdir, "test_rdoc_servlet_#{$$}" - Gem.use_paths @tempdir - Gem.ensure_gem_subdirectories @tempdir - - @spec = Gem::Specification.new 'spec', '1.0' - @spec.loaded_from = @spec.spec_file - - Gem::Specification.reset - Gem::Specification.all = [@spec] - - @server = {} - def @server.mount(*) end - - @stores = {} - @cache = Hash.new { |hash, store| hash[store] = {} } - - @extra_dirs = [File.join(@tempdir, 'extra1'), File.join(@tempdir, 'extra2')] - - @s = RDoc::Servlet.new @server, @stores, @cache, nil, @extra_dirs - - @req = WEBrick::HTTPRequest.new :Logger => nil - @res = WEBrick::HTTPResponse.new :HTTPVersion => '1.0' - - def @req.path= path - instance_variable_set :@path, path - end - - @req.instance_variable_set :@header, Hash.new { |h, k| h[k] = [] } - - @base = File.join @tempdir, 'base' - @system_dir = File.join @tempdir, 'base', 'system' - @home_dir = File.join @tempdir, 'home' - @gem_doc_dir = File.join @tempdir, 'doc' - - @orig_base = RDoc::RI::Paths::BASE - RDoc::RI::Paths::BASE.replace @base - @orig_ri_path_homedir = RDoc::RI::Paths::HOMEDIR - RDoc::RI::Paths.send :remove_const, :HOMEDIR - RDoc::RI::Paths.const_set :HOMEDIR, @home_dir - - RDoc::RI::Paths.instance_variable_set \ - :@gemdirs, %w[/nonexistent/gems/example-1.0/ri] - end - - def teardown - super - - Gem.use_paths(*@orig_gem_path) - Gem::Specification.reset - - FileUtils.rm_rf @tempdir - - RDoc::RI::Paths::BASE.replace @orig_base - RDoc::RI::Paths.send :remove_const, :HOMEDIR - RDoc::RI::Paths.const_set :HOMEDIR, @orig_ri_path_homedir - RDoc::RI::Paths.instance_variable_set :@gemdirs, nil - end - - def test_asset - temp_dir do - FileUtils.mkdir 'css' - - now = Time.now - File.open 'css/rdoc.css', 'w' do |io| io.write 'h1 { color: red }' end - File.utime now, now, 'css/rdoc.css' - - @s.asset_dirs[:darkfish] = '.' - - @req.path = '/css/rdoc.css' - - @s.asset :darkfish, @req, @res - - assert_equal 'h1 { color: red }', @res.body - assert_equal 'text/css', @res.content_type - assert_equal now.httpdate, @res['last-modified'] - end - end - - def test_do_GET - touch_system_cache_path - - @req.path = '/ruby/Missing.html' - - @s.do_GET @req, @res - - assert_equal 404, @res.status - end - - def test_do_GET_asset_darkfish - temp_dir do - FileUtils.mkdir 'css' - FileUtils.touch 'css/rdoc.css' - - @s.asset_dirs[:darkfish] = '.' - - @req.path = '/css/rdoc.css' - - @s.do_GET @req, @res - - assert_equal 'text/css', @res.content_type - end - end - - def test_do_GET_asset_json_index - temp_dir do - FileUtils.mkdir 'js' - FileUtils.touch 'js/navigation.js' - - @s.asset_dirs[:json_index] = '.' - - @req.path = '/js/navigation.js' - - @s.do_GET @req, @res - - assert_equal 'application/javascript', @res.content_type - end - end - - def test_do_GET_error - touch_system_cache_path - - def @req.path() raise 'no' end - - @s.do_GET @req, @res - - assert_equal 500, @res.status - end - - def test_do_GET_mount_path - @s = RDoc::Servlet.new @server, @stores, @cache, '/mount/path' - - temp_dir do - FileUtils.mkdir 'css' - FileUtils.touch 'css/rdoc.css' - - @s.asset_dirs[:darkfish] = '.' - - @req.path = '/mount/path/css/rdoc.css'.dup - - @s.do_GET @req, @res - - assert_equal 'text/css', @res.content_type - end - end - - def do_GET_not_found - touch_system_cache_path - - @req.path = "/#{@spec.full_name}" - - @s.do_GET @req, @res - - assert_equal 404, @res.status - end - - def test_do_GET_not_modified - touch_system_cache_path - @req.header['if-modified-since'] = [(Time.now + 10).httpdate] - @req.path = '/ruby/Missing.html' - - assert_raise WEBrick::HTTPStatus::NotModified do - @s.do_GET @req, @res - end - end - - def test_do_GET_root - touch_system_cache_path - - @req.path = '/' - - @s.do_GET @req, @res - - assert_equal 'text/html', @res.content_type - assert_match %r%<title>Local RDoc Documentation%, @res.body - end - - def test_do_GET_root_search - touch_system_cache_path - - @req.path = '/js/search_index.js' - - @s.do_GET @req, @res - - assert_equal 'application/javascript', @res.content_type, @res.body - end - - def test_documentation_page_class - store = RDoc::Store.new - - generator = @s.generator_for store - - file = store.add_file 'file.rb' - klass = file.add_class RDoc::NormalClass, 'Klass' - klass.add_class RDoc::NormalClass, 'Sub' - - @s.documentation_page store, generator, 'Klass::Sub.html', @req, @res - - assert_match %r%class Klass::Sub - %, @res.body - assert_match %r%%, @res.body - end - - def test_documentation_page_not_found - store = RDoc::Store.new - - generator = @s.generator_for store - - @req.path = '/ruby/Missing.html' - - @s.documentation_page store, generator, 'Missing.html', @req, @res - - assert_equal 404, @res.status - end - - def test_documentation_page_page - store = RDoc::Store.new - - generator = @s.generator_for store - - store.add_file 'README.rdoc', parser: RDoc::Parser::Simple - - @s.documentation_page store, generator, 'README_rdoc.html', @req, @res - - assert_match %r%README - %, @res.body - assert_match %r%]+ class="file">%, @res.body - end - - def test_documentation_page_page_with_nesting - store = RDoc::Store.new - - generator = @s.generator_for store - - store.add_file 'nesting/README.rdoc', parser: RDoc::Parser::Simple - - @s.documentation_page store, generator, 'nesting/README_rdoc.html', @req, @res - - assert_equal 200, @res.status - end - - def test_documentation_source - store, path = @s.documentation_source '/ruby/Object.html' - - assert_equal @system_dir, store.path - - assert_equal 'Object.html', path - end - - def test_documentation_source_cached - cached_store = RDoc::Store.new - - @stores['ruby'] = cached_store - - store, path = @s.documentation_source '/ruby/Object.html' - - assert_same cached_store, store - - assert_equal 'Object.html', path - end - - def test_error - e = RuntimeError.new 'foo' - e.set_backtrace caller - - @s.error e, @req, @res - - assert_equal 'text/html', @res.content_type - assert_equal 500, @res.status - assert_match %r%Error%, @res.body - end - - def test_generator_for - store = RDoc::Store.new - store.main = 'MAIN_PAGE.rdoc' - store.title = 'Title' - - generator = @s.generator_for store - - refute generator.file_output - - assert_equal '..', generator.asset_rel_path - - assert_equal 'MAIN_PAGE.rdoc', @s.options.main_page - assert_equal 'Title', @s.options.title - - assert_kind_of RDoc::RDoc, store.rdoc - assert_same generator, store.rdoc.generator - end - - def test_if_modified_since - omit 'File.utime on directory not supported' if Gem.win_platform? - - temp_dir do - now = Time.now - File.utime now, now, '.' - - @s.if_modified_since @req, @res, '.' - - assert_equal now.to_i, Time.parse(@res['last-modified']).to_i - end - end - - def test_if_modified_since_not_modified - omit 'File.utime on directory not supported' if Gem.win_platform? - - temp_dir do - now = Time.now - File.utime now, now, '.' - - @req.header['if-modified-since'] = [(now + 10).httpdate] - - assert_raise WEBrick::HTTPStatus::NotModified do - @s.if_modified_since @req, @res, '.' - end - - assert_equal now.to_i, Time.parse(@res['last-modified']).to_i - end - end - - def test_installed_docs - touch_system_cache_path - touch_extra_cache_path - - expected = [ - ['My Extra Documentation', 'extra-1/', true, :extra, - @extra_dirs[0]], - ['Extra Documentation', 'extra-2/', false, :extra, - @extra_dirs[1]], - ['Ruby Documentation', 'ruby/', true, :system, - @system_dir], - ['Site Documentation', 'site/', false, :site, - File.join(@base, 'site')], - ['Home Documentation', 'home/', false, :home, - RDoc::RI::Paths::HOMEDIR], - ['spec-1.0', 'spec-1.0/', false, :gem, - File.join(@spec.doc_dir, 'ri')], - ] - - assert_equal expected, @s.installed_docs - end - - def test_not_found - generator = @s.generator_for RDoc::Store.new - - @req.path = '/ruby/Missing.html' - - @s.not_found generator, @req, @res - - assert_equal 404, @res.status - assert_match %r%<title>Not Found%, @res.body - assert_match %r%/ruby/Missing\.html%, @res.body - end - - def test_not_found_message - generator = @s.generator_for RDoc::Store.new - - @req.path = '/ruby/Missing.html' - - @s.not_found generator, @req, @res, 'woo, this is a message' - - assert_equal 404, @res.status - assert_match %r%Not Found%, @res.body - assert_match %r%woo, this is a message%, @res.body - end - - def test_ri_paths - paths = @s.ri_paths - - expected = [ - [@extra_dirs[0], :extra], - [@extra_dirs[1], :extra], - [@system_dir, :system], - [File.join(@base, 'site'), :site], - [RDoc::RI::Paths::HOMEDIR, :home], - [File.join(@spec.doc_dir, 'ri'), :gem], - ] - - assert_equal expected, paths.to_a - end - - def test_root - @s.root @req, @res - - assert_equal 'text/html', @res.content_type - assert_match %r%Local RDoc Documentation%, @res.body - end - - def test_root_search - touch_system_cache_path - touch_extra_cache_path - - @s.root_search @req, @res - - assert_equal 'application/javascript', @res.content_type - - @res.body =~ /\{.*\}/ - - index = JSON.parse $& - - expected = { - 'index' => { - 'searchIndex' => %w[ - My\ Extra\ Documentation - Ruby\ Documentation - ], - 'longSearchIndex' => %w[ - My\ Extra\ Documentation - Ruby\ Documentation - ], - 'info' => [ - ['My Extra Documentation', '', @extra_dirs[0], '', - 'My Extra Documentation'], - ['Ruby Documentation', '', 'ruby', '', - 'Documentation for the Ruby standard library'], - ], - } - } - - assert_equal expected, index - end - - def test_show_documentation_index - touch_system_cache_path - - @req.path = '/ruby' - - @s.show_documentation @req, @res - - assert_equal 'text/html', @res.content_type - assert_match %r%Standard Library Documentation%, @res.body - end - - def test_show_documentation_table_of_contents - touch_system_cache_path - - @req.path = '/ruby/table_of_contents.html' - - @s.show_documentation @req, @res - - assert_equal 'text/html', @res.content_type - assert_match %r%<title>Table of Contents - Standard Library Documentation%, - @res.body - end - - def test_show_documentation_page - touch_system_cache_path - - @req.path = '/ruby/Missing.html' - - @s.show_documentation @req, @res - - assert_equal 404, @res.status - end - - def test_show_documentation_search_index - touch_system_cache_path - - @req.path = '/ruby/js/search_index.js' - - @s.show_documentation @req, @res - - assert_equal 'application/javascript', @res.content_type - assert_match %r%\Avar search_data =%, @res.body - end - - def test_store_for_gem - ri_dir = File.join @gem_doc_dir, 'spec-1.0', 'ri' - FileUtils.mkdir_p ri_dir - FileUtils.touch File.join ri_dir, 'cache.ri' - - store = @s.store_for 'spec-1.0' - - assert_equal File.join(@gem_doc_dir, 'spec-1.0', 'ri'), store.path - assert_equal :gem, store.type - end - - def test_store_for_home - store = @s.store_for 'home' - - assert_equal @home_dir, store.path - assert_equal :home, store.type - end - - def test_store_for_missing_documentation - FileUtils.mkdir_p(File.join @gem_doc_dir, 'spec-1.0', 'ri') - - e = assert_raise WEBrick::HTTPStatus::NotFound do - @s.store_for 'spec-1.0' - end - - assert_equal 'Could not find documentation for "spec-1.0". Please run `gem rdoc --ri gem_name`', - e.message - end - - def test_store_for_missing_gem - e = assert_raise WEBrick::HTTPStatus::NotFound do - @s.store_for 'missing' - end - - assert_equal 'Could not find gem "missing". Are you sure you installed it?', - e.message - end - - def test_store_for_ruby - store = @s.store_for 'ruby' - - assert_equal @system_dir, store.path - assert_equal :system, store.type - end - - def test_store_for_site - store = @s.store_for 'site' - - assert_equal File.join(@base, 'site'), store.path - assert_equal :site, store.type - end - - def test_store_for_extra - store = @s.store_for 'extra-1' - - assert_equal @extra_dirs.first, store.path - assert_equal :extra, store.type - end - - def touch_system_cache_path - store = RDoc::Store.new @system_dir - store.title = 'Standard Library Documentation' - - FileUtils.mkdir_p File.dirname store.cache_path - - store.save - end - - def touch_extra_cache_path - store = RDoc::Store.new @extra_dirs.first - store.title = 'My Extra Documentation' - - FileUtils.mkdir_p File.dirname store.cache_path - - store.save - end - -end if defined?(WEBrick) diff --git a/test/rdoc/test_rdoc_single_class.rb b/test/rdoc/test_rdoc_single_class.rb deleted file mode 100644 index e81a1498ba..0000000000 --- a/test/rdoc/test_rdoc_single_class.rb +++ /dev/null @@ -1,20 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocSingleClass < RDoc::TestCase - - def setup - super - - @c = RDoc::SingleClass.new 'C' - end - - def test_aref_prefix - assert_equal 'sclass', @c.aref_prefix - end - - def test_definition - assert_equal 'class << C', @c.definition - end - -end diff --git a/test/rdoc/test_rdoc_stats.rb b/test/rdoc/test_rdoc_stats.rb deleted file mode 100644 index ce272d36cf..0000000000 --- a/test/rdoc/test_rdoc_stats.rb +++ /dev/null @@ -1,722 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocStats < RDoc::TestCase - - def setup - super - - @s = RDoc::Stats.new @store, 0 - - @tl = @store.add_file 'file.rb' - @tl.parser = RDoc::Parser::Ruby - end - - def test_doc_stats - c = RDoc::CodeObject.new - - assert_equal [1, 1], @s.doc_stats([c]) - end - - def test_doc_stats_documented - c = RDoc::CodeObject.new - c.comment = comment 'x' - - assert_equal [1, 0], @s.doc_stats([c]) - end - - def test_doc_stats_display_eh - c = RDoc::CodeObject.new - c.ignore - - assert_equal [0, 0], @s.doc_stats([c]) - end - - def test_report_attr - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - a = RDoc::Attr.new nil, 'a', 'RW', nil - a.record_location @tl - c.add_attribute a - - @store.complete :public - - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - verb( - "class C # is documented\n", - "\n", - " attr_accessor :a # in file file.rb\n", - "\n", - "end\n"), - blank_line) - - assert_equal expected, report - end - - def test_report_attr_documented - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - a = RDoc::Attr.new nil, 'a', 'RW', 'a' - a.record_location @tl - c.add_attribute a - - @store.complete :public - - report = @s.report - - assert_equal @s.great_job, report - end - - def test_report_attr_line - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - a = RDoc::Attr.new nil, 'a', 'RW', nil - a.record_location @tl - a.line = 3 - c.add_attribute a - - @store.complete :public - - assert_match '# in file file.rb:3', @s.report.accept(to_rdoc) - end - - def test_report_constant - m = @tl.add_module RDoc::NormalModule, 'M' - m.record_location @tl - m.add_comment 'M', @tl - - c = RDoc::Constant.new 'C', nil, nil - c.record_location @tl - m.add_constant c - - @store.complete :public - - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - verb( - "module M # is documented\n", - "\n", - " # in file file.rb\n", - " C = nil\n", - "\n", - "end\n"), - blank_line) - - assert_equal expected, report - end - - def test_report_constant_alias - mod = @tl.add_module RDoc::NormalModule, 'M' - - c = @tl.add_class RDoc::NormalClass, 'C' - mod.add_constant c - - ca = RDoc::Constant.new 'CA', nil, nil - ca.is_alias_for = c - - @tl.add_constant ca - - @store.complete :public - - report = @s.report - - # TODO change this to refute match, aliases should be ignored as they are - # programmer convenience constructs - assert_match 'class Object', report.accept(to_rdoc) - end - - def test_report_constant_documented - m = @tl.add_module RDoc::NormalModule, 'M' - m.record_location @tl - m.add_comment 'M', @tl - - c = RDoc::Constant.new 'C', nil, 'C' - c.record_location @tl - m.add_constant c - - @store.complete :public - - report = @s.report - - assert_equal @s.great_job, report - end - - def test_report_constant_line - m = @tl.add_module RDoc::NormalModule, 'M' - m.record_location @tl - m.add_comment 'M', @tl - - c = RDoc::Constant.new 'C', nil, nil - c.record_location @tl - c.line = 5 - m.add_constant c - - @store.complete :public - - assert_match '# in file file.rb:5', @s.report.accept(to_rdoc) - end - - def test_report_class - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - c.add_method m - m.comment = 'm' - - @store.complete :public - - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - para('In files:'), - list(:BULLET, *[ - item(nil, para('file.rb'))]), - blank_line, - verb("class C\n", "end\n"), - blank_line) - - assert_equal expected, report - end - - def test_report_skip_object - c = @tl.add_class RDoc::NormalClass, 'Object' - c.record_location @tl - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - c.add_method m - m.comment = 'm' - - @store.complete :public - - refute_match %r%^class Object$%, @s.report.accept(to_rdoc) - end - - def test_report_class_documented - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - c.add_method m - m.comment = 'm' - - @store.complete :public - - report = @s.report - - assert_equal @s.great_job, report - end - - def test_report_class_documented_level_1 - c1 = @tl.add_class RDoc::NormalClass, 'C1' - c1.record_location @tl - c1.add_comment 'C1', @tl - - m1 = RDoc::AnyMethod.new nil, 'm1' - m1.record_location @tl - c1.add_method m1 - m1.comment = 'm1' - - c2 = @tl.add_class RDoc::NormalClass, 'C2' - c2.record_location @tl - - m2 = RDoc::AnyMethod.new nil, 'm2' - m2.record_location @tl - c2.add_method m2 - m2.comment = 'm2' - - @store.complete :public - - @s.coverage_level = 1 - - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - para('In files:'), - list(:BULLET, *[ - item(nil, para('file.rb'))]), - blank_line, - verb("class C2\n", "end\n"), - blank_line) - - assert_equal expected, report - end - - def test_report_class_empty - @tl.add_class RDoc::NormalClass, 'C' - - @store.complete :public - - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - para('class C is referenced but empty.'), - para("It probably came from another project. I'm sorry I'm holding it against you."), - blank_line) - - assert_equal expected, report - end - - def test_report_class_empty_2 - c1 = @tl.add_class RDoc::NormalClass, 'C1' - c1.record_location @tl - - c2 = @tl.add_class RDoc::NormalClass, 'C2' - c2.record_location @tl - c2.add_comment 'C2', @tl - - @store.complete :public - - @s.coverage_level = 1 - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - para('In files:'), - list(:BULLET, *[ - item(nil, para('file.rb'))]), - blank_line, - verb("class C1\n", "end\n"), - blank_line) - - assert_equal expected, report - end - - def test_report_class_method_documented - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - c.add_method m - m.comment = 'm' - - @store.complete :public - - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - para('In files:'), - list(:BULLET, *[ - item(nil, para('file.rb'))]), - blank_line, - verb("class C\n", "end\n"), - blank_line) - - assert_equal expected, report - end - - def test_report_class_module_ignore - c = @tl.add_class RDoc::NormalClass, 'C' - c.ignore - - @store.complete :public - - report = @s.report_class_module c - - assert_nil report - end - - def test_report_empty - @store.complete :public - - report = @s.report - - assert_equal @s.great_job, report - end - - def test_report_method - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m1 = RDoc::AnyMethod.new nil, 'm1' - m1.record_location @tl - c.add_method m1 - - m2 = RDoc::AnyMethod.new nil, 'm2' - m2.record_location @tl - c.add_method m2 - m2.comment = 'm2' - - @store.complete :public - - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - verb(*[ - "class C # is documented\n", - "\n", - " # in file file.rb\n", - " def m1; end\n", - "\n", - "end\n"]), - blank_line) - - assert_equal expected, report - end - - def test_report_method_class - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m1 = RDoc::AnyMethod.new nil, 'm1' - m1.record_location @tl - m1.singleton = true - c.add_method m1 - - m2 = RDoc::AnyMethod.new nil, 'm2' - m2.record_location @tl - m2.singleton = true - c.add_method m2 - m2.comment = 'm2' - - @store.complete :public - - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - verb(*[ - "class C # is documented\n", - "\n", - " # in file file.rb\n", - " def self.m1; end\n", - "\n", - "end\n"]), - blank_line) - - assert_equal expected, report - end - - def test_report_method_documented - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - c.add_method m - m.comment = 'm' - - @store.complete :public - - report = @s.report - - assert_equal @s.great_job, report - end - - def test_report_method_line - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m1 = RDoc::AnyMethod.new nil, 'm1' - m1.record_location @tl - m1.line = 4 - c.add_method m1 - - @store.complete :public - - assert_match '# in file file.rb:4', @s.report.accept(to_rdoc) - end - - def test_report_method_parameters - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m1 = RDoc::AnyMethod.new nil, 'm1' - m1.record_location @tl - m1.params = '(p1, p2)' - m1.comment = 'Stuff with +p1+' - c.add_method m1 - - m2 = RDoc::AnyMethod.new nil, 'm2' - m2.record_location @tl - c.add_method m2 - m2.comment = 'm2' - - @store.complete :public - - @s.coverage_level = 1 - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - verb(*[ - "class C # is documented\n", - "\n", - " # in file file.rb\n", - " # +p2+ is not documented\n", - " def m1(p1, p2); end\n", - "\n", - "end\n"]), - blank_line) - - assert_equal expected, report - end - - def test_report_method_parameters_documented - @tl.parser = RDoc::Parser::Ruby - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - m.params = '(p1)' - m.comment = 'Stuff with +p1+' - c.add_method m - - @store.complete :public - - @s.coverage_level = 1 - report = @s.report - - assert_equal @s.great_job, report - end - - def test_report_method_parameters_yield - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - m.call_seq = <<-SEQ -m(a) { |c| ... } -m(a, b) { |c, d| ... } - SEQ - m.comment = 'Stuff with +a+, yields +c+ for you to do stuff with' - c.add_method m - - @store.complete :public - - @s.coverage_level = 1 - report = @s.report - - expected = - doc( - para('The following items are not documented:'), - blank_line, - verb( - "class C # is documented\n", - "\n", - " # in file file.rb\n", - " # +b+, +d+ is not documented\n", - " def m; end\n", - "\n", - "end\n"), - blank_line) - - assert_equal expected, report - end - - def test_summary - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - - m = @tl.add_module RDoc::NormalModule, 'M' - m.record_location @tl - - a = RDoc::Attr.new nil, 'a', 'RW', nil - a.record_location @tl - c.add_attribute a - - c_c = RDoc::Constant.new 'C', nil, nil - c_c.record_location @tl - c.add_constant c_c - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - c.add_method m - - @store.complete :public - - summary = @s.summary.accept to_rdoc - summary.sub!(/ Elapsed:.*/m, '') - - expected = <<-EXPECTED - Files: 0 - - Classes: 1 (1 undocumented) - Modules: 1 (1 undocumented) - Constants: 1 (1 undocumented) - Attributes: 1 (1 undocumented) - Methods: 1 (1 undocumented) - - Total: 5 (5 undocumented) - 0.00% documented - - EXPECTED - - assert_equal summary, expected - end - - def test_summary_level_false - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - - @store.complete :public - - @s.coverage_level = false - - summary = @s.summary.accept to_rdoc - summary.sub!(/ Elapsed:.*/m, '') - - expected = <<-EXPECTED - Files: 0 - - Classes: 1 (1 undocumented) - Modules: 0 (0 undocumented) - Constants: 0 (0 undocumented) - Attributes: 0 (0 undocumented) - Methods: 0 (0 undocumented) - - Total: 1 (1 undocumented) - 0.00% documented - - EXPECTED - - assert_equal summary, expected - end - - def test_summary_level_1 - c = @tl.add_class RDoc::NormalClass, 'C' - c.record_location @tl - c.add_comment 'C', @tl - - m = RDoc::AnyMethod.new nil, 'm' - m.record_location @tl - m.params = '(p1, p2)' - m.comment = 'Stuff with +p1+' - c.add_method m - - @store.complete :public - - @s.coverage_level = 1 - @s.report - - summary = @s.summary.accept to_rdoc - summary.sub!(/ Elapsed:.*/m, '') - - expected = <<-EXPECTED - Files: 0 - - Classes: 1 (0 undocumented) - Modules: 0 (0 undocumented) - Constants: 0 (0 undocumented) - Attributes: 0 (0 undocumented) - Methods: 1 (0 undocumented) - Parameters: 2 (1 undocumented) - - Total: 4 (1 undocumented) - 75.00% documented - - EXPECTED - - assert_equal summary, expected - end - - def to_rdoc - RDoc::Markup::ToRdoc.new - end - - def test_undoc_params - method = RDoc::AnyMethod.new [], 'm' - method.params = '(a)' - method.comment = comment 'comment' - - total, undoc = @s.undoc_params method - - assert_equal 1, total - assert_equal %w[a], undoc - end - - def test_undoc_params_block - method = RDoc::AnyMethod.new [], 'm' - method.params = '(&a)' - method.comment = comment '+a+' - - total, undoc = @s.undoc_params method - - assert_equal 1, total - assert_empty undoc - end - - def test_undoc_params_documented - method = RDoc::AnyMethod.new [], 'm' - method.params = '(a)' - method.comment = comment '+a+' - - total, undoc = @s.undoc_params method - - assert_equal 1, total - assert_empty undoc - end - - def test_undoc_params_keywords - method = RDoc::AnyMethod.new [], 'm' - method.params = '(**a)' - method.comment = comment '+a+' - - total, undoc = @s.undoc_params method - - assert_equal 1, total - assert_empty undoc - end - - def test_undoc_params_splat - method = RDoc::AnyMethod.new [], 'm' - method.params = '(*a)' - method.comment = comment '+a+' - - total, undoc = @s.undoc_params method - - assert_equal 1, total - assert_empty undoc - end - -end diff --git a/test/rdoc/test_rdoc_store.rb b/test/rdoc/test_rdoc_store.rb deleted file mode 100644 index 2665f163e4..0000000000 --- a/test/rdoc/test_rdoc_store.rb +++ /dev/null @@ -1,1032 +0,0 @@ -# frozen_string_literal: true -require_relative 'xref_test_case' - -class TestRDocStore < XrefTestCase - - OBJECT_ANCESTORS = %w[BasicObject] - - def setup - super - - @tmpdir = File.join Dir.tmpdir, "test_rdoc_ri_store_#{$$}" - @s = RDoc::RI::Store.new @tmpdir - @s.rdoc = @rdoc - - @top_level = @s.add_file 'file.rb' - - @page = @s.add_file 'README.txt', parser: RDoc::Parser::Simple - @page.comment = RDoc::Comment.new 'This is a page', @page - - @klass = @top_level.add_class RDoc::NormalClass, 'Object' - @klass.add_comment 'original', @top_level - @klass.record_location @top_level - - @cmeth = RDoc::AnyMethod.new nil, 'cmethod' - @cmeth.singleton = true - @cmeth.record_location @top_level - - @meth_comment = RDoc::Comment.new 'method comment' - @meth_comment.location = @top_level - - @meth = RDoc::AnyMethod.new nil, 'method' - @meth.record_location @top_level - @meth.comment = @meth_comment - - @meth_bang = RDoc::AnyMethod.new nil, 'method!' - @meth_bang.record_location @top_level - - @meth_bang_alias = RDoc::Alias.new nil, 'method!', 'method_bang', '' - @meth_bang_alias.record_location @top_level - - @meth_bang.add_alias @meth_bang_alias, @klass - - @attr_comment = RDoc::Comment.new 'attribute comment' - @attr_comment.location = @top_level - - @attr = RDoc::Attr.new nil, 'attr', 'RW', '' - @attr.record_location @top_level - @attr.comment = @attr_comment - - @klass.add_method @cmeth - @klass.add_method @meth - @klass.add_method @meth_bang - @klass.add_attribute @attr - - @nest_klass = @klass.add_class RDoc::NormalClass, 'SubClass' - @nest_meth = RDoc::AnyMethod.new nil, 'method' - @nest_meth.record_location @top_level - - @nest_incl = RDoc::Include.new 'Incl', '' - @nest_incl.record_location @top_level - - @nest_klass.add_method @nest_meth - @nest_klass.add_include @nest_incl - - @mod = @top_level.add_module RDoc::NormalModule, 'Mod' - @mod.record_location @top_level - end - - def teardown - super - - FileUtils.rm_rf @tmpdir - end - - def assert_cache imethods, cmethods, attrs, modules, - ancestors = {}, pages = [], main = nil, title = nil - imethods ||= { 'Object' => %w[method method! method_bang] } - cmethods ||= { 'Object' => %w[cmethod] } - attrs ||= { 'Object' => ['attr_accessor attr'] } - - # this is sort-of a hack - @s.clean_cache_collection ancestors - - expected = { - :ancestors => ancestors, - :attributes => attrs, - :class_methods => cmethods, - :c_class_variables => {}, - :c_singleton_class_variables => {}, - :encoding => nil, - :instance_methods => imethods, - :modules => modules, - :pages => pages, - :main => main, - :title => title, - } - - @s.save_cache - - assert_equal expected, @s.cache - end - - def test_add_c_enclosure - @s.add_c_enclosure 'cC1', @c1 - - expected = { 'cC1' => @c1 } - - assert_equal expected, @s.c_enclosure_classes - end - - def test_add_c_variables - options = RDoc::Options.new - - c_file = @s.add_file 'ext.c' - - some_ext = c_file.add_class RDoc::NormalClass, 'SomeExt' - c_file.add_class RDoc::SingleClass, 'SomeExtSingle' - - c_parser = RDoc::Parser::C.new c_file, 'ext.c', '', options, nil - - c_parser.classes['cSomeExt'] = some_ext - c_parser.singleton_classes['s_cSomeExt'] = 'SomeExtSingle' - - @s.add_c_variables c_parser - - expected = { 'ext.c' => { 'cSomeExt' => 'SomeExt' } } - - assert_equal expected, @s.c_class_variables - - expected = { 'ext.c' => { 's_cSomeExt' => 'SomeExtSingle' } } - - assert_equal expected, @s.c_singleton_class_variables - end - - def test_add_file - top_level = @store.add_file 'file.rb' - - assert_kind_of RDoc::TopLevel, top_level - assert_equal @store, top_level.store - assert_equal 'file.rb', top_level.name - assert_includes @store.all_files, top_level - - assert_same top_level, @store.add_file('file.rb') - refute_same top_level, @store.add_file('other.rb') - end - - def test_add_file_relative - top_level = @store.add_file 'path/file.rb', relative_name: 'file.rb' - - assert_kind_of RDoc::TopLevel, top_level - assert_equal @store, top_level.store - - assert_equal 'path/file.rb', top_level.absolute_name - assert_equal 'file.rb', top_level.relative_name - - assert_includes @store.all_files, top_level - - assert_same top_level, @store.add_file('file.rb') - refute_same top_level, @store.add_file('other.rb') - end - - def test_all_classes_and_modules - expected = %w[ - C1 C10 C10::C11 C11 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4 C5 C5::C1 C6 C7 C8 C8::S1 C9 C9::A C9::B - Child - M1 M1::M2 - Object - Parent - ] - - assert_equal expected, - @store.all_classes_and_modules.map { |m| m.full_name }.sort - end - - def test_all_files - assert_equal %w[EXAMPLE.md xref_data.rb], - @store.all_files.map { |m| m.full_name }.sort - end - - def test_all_modules - assert_equal %w[M1 M1::M2], - @store.all_modules.map { |m| m.full_name }.sort - end - - def test_attributes - @s.cache[:attributes]['Object'] = %w[attr] - - expected = { 'Object' => %w[attr] } - - assert_equal expected, @s.attributes - end - - def test_class_file - assert_equal File.join(@tmpdir, 'Object', 'cdesc-Object.ri'), - @s.class_file('Object') - assert_equal File.join(@tmpdir, 'Object', 'SubClass', 'cdesc-SubClass.ri'), - @s.class_file('Object::SubClass') - end - - def test_class_methods - @s.cache[:class_methods]['Object'] = %w[method] - - expected = { 'Object' => %w[method] } - - assert_equal expected, @s.class_methods - end - - def test_class_path - assert_equal File.join(@tmpdir, 'Object'), @s.class_path('Object') - assert_equal File.join(@tmpdir, 'Object', 'SubClass'), - @s.class_path('Object::SubClass') - end - - def test_classes - expected = %w[ - C1 C10 C10::C11 C11 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4 C5 C5::C1 C6 C7 C8 C8::S1 C9 C9::A C9::B - Child - Object - Parent - ] - - assert_equal expected, @store.all_classes.map { |m| m.full_name }.sort - end - - def test_complete - a1 = RDoc::Constant.new 'A1', '', '' - @c2.add_module_alias @c2_c3, @c2_c3.name, a1, @top_level - - @store.complete :public - - a1 = @xref_data.find_class_or_module 'C2::A1' - - assert_equal 'C2::A1', a1.full_name - refute_empty a1.aliases - end - - def test_complete_nodoc - c_nodoc = @top_level.add_class RDoc::NormalClass, 'Nodoc' - c_nodoc.record_location @top_level - c_nodoc.document_self = nil - - @s.complete :nodoc - - assert_includes @s.classes_hash.keys, 'Nodoc' - end - - def test_find_c_enclosure - assert_nil @s.find_c_enclosure 'cC1' - - @s.add_c_enclosure 'cC1', @c1 - - assert_equal @c1, @s.find_c_enclosure('cC1') - end - - def test_find_c_enclosure_from_cache - @s.save_class @klass - @s.classes_hash.clear - - assert_nil @s.find_c_enclosure 'cObject' - - @s.c_enclosure_names['cObject'] = 'Object' - - klass = @s.find_c_enclosure('cObject') - assert_equal @klass, klass - - assert_empty klass.comment_location - assert_equal @top_level, klass.parent - - assert_includes @s.c_enclosure_classes, 'cObject' - end - - def test_find_c_enclosure_from_cache_legacy - @klass.in_files.clear - @s.save_class @klass - @s.classes_hash.clear - - assert_nil @s.find_c_enclosure 'cObject' - - @s.c_enclosure_names['cObject'] = 'Object' - - assert_nil @s.find_c_enclosure('cObject') - end - - def test_resolve_c_superclasses - # first parse a child that references an unknown parent - c_file1 = @s.add_file 'ext1.c' - c_file1.add_class RDoc::NormalClass, 'Child', 'cExternParent' - - # then parse the parent and register the C variable name as a C enclosure - c_file2 = @s.add_file 'ext2.c' - parent = c_file2.add_class RDoc::NormalClass, 'Parent', 'rb_cObject' - - @s.add_c_enclosure('cExternParent', parent) - - # at this point, the child's superclass is still the name of the C variable - assert_equal("cExternParent", @s.classes_hash['Child'].superclass) - - @s.resolve_c_superclasses - - # now the ancestor tree correctly references the NormalClass objects - assert_equal(parent, @s.classes_hash['Child'].superclass) - end - - def test_find_class_named - assert_equal @c1, @store.find_class_named('C1') - - assert_equal @c2_c3, @store.find_class_named('C2::C3') - end - - def test_find_class_named_from - assert_equal @c5_c1, @store.find_class_named_from('C1', 'C5') - - assert_equal @c1, @store.find_class_named_from('C1', 'C4') - end - - def test_find_class_or_module - assert_equal @m1, @store.find_class_or_module('M1') - assert_equal @c1, @store.find_class_or_module('C1') - - assert_equal @m1, @store.find_class_or_module('::M1') - assert_equal @c1, @store.find_class_or_module('::C1') - end - - def test_find_file_named - assert_equal @xref_data, @store.find_file_named(@file_name) - end - - def test_find_module_named - assert_equal @m1, @store.find_module_named('M1') - assert_equal @m1_m2, @store.find_module_named('M1::M2') - end - - def test_find_text_page - page = @store.add_file 'PAGE.txt', parser: RDoc::Parser::Simple - - assert_nil @store.find_text_page 'no such page' - - assert_equal page, @store.find_text_page('PAGE.txt') - end - - def test_friendly_path - @orig_xdg_data_home = ENV.delete('XDG_DATA_HOME') - - @s.path = @tmpdir - @s.type = nil - assert_equal @s.path, @s.friendly_path - - @s.type = :extra - assert_equal @s.path, @s.friendly_path - - @s.type = :system - assert_equal "ruby core", @s.friendly_path - - @s.type = :site - assert_equal "ruby site", @s.friendly_path - - @s.type = :home - assert_equal File.expand_path("~/.local/share/rdoc"), @s.friendly_path - - @s.type = :gem - @s.path = "#{@tmpdir}/gem_repository/doc/gem_name-1.0/ri" - assert_equal "gem gem_name-1.0", @s.friendly_path - ensure - ENV['XDG_DATA_HOME'] = @orig_xdg_data_home - end - - def test_dry_run - refute @s.dry_run - - @s.dry_run = true - - assert @s.dry_run - end - - def test_instance_methods - @s.cache[:instance_methods]['Object'] = %w[method] - - expected = { 'Object' => %w[method] } - - assert_equal expected, @s.instance_methods - end - - def test_load_all - FileUtils.mkdir_p @tmpdir - - @s.save - - s = RDoc::Store.new @tmpdir - - s.load_all - - assert_equal [@klass, @nest_klass], s.all_classes.sort - assert_equal [@mod], s.all_modules.sort - assert_equal [@page, @top_level], s.all_files.sort - - methods = s.all_classes_and_modules.flat_map do |mod| - mod.method_list - end.sort - - _meth_bang_alias = RDoc::AnyMethod.new nil, 'method_bang' - _meth_bang_alias.parent = @klass - - assert_equal [@meth, @meth_bang, _meth_bang_alias, @nest_meth, @cmeth], - methods.sort_by { |m| m.full_name } - - method = methods.find { |m| m == @meth } - assert_equal @meth_comment.parse, method.comment - - assert_equal @klass, methods.last.parent - - attributes = s.all_classes_and_modules.flat_map do |mod| - mod.attributes - end.sort - - assert_equal [@attr], attributes - - assert_equal @attr_comment.parse, attributes.first.comment - end - - def test_load_cache - cache = { - :c_class_variables => - { 'file.c' => { 'cKlass' => 'Klass' } }, - :c_singleton_class_variables => - { 'file.c' => { 'sKlass' => 'KlassSingle' } }, - :encoding => :encoding_value, - :methods => { "Object" => %w[Object#method] }, - :main => @page.full_name, - :modules => %w[Object], - :pages => [], - } - - Dir.mkdir @tmpdir - - File.open File.join(@tmpdir, 'cache.ri'), 'wb' do |io| - Marshal.dump cache, io - end - - @s.load_cache - - assert_equal cache, @s.cache - - assert_equal :encoding_value, @s.encoding - assert_equal 'README.txt', @s.main - - expected = { 'file.c' => { 'cKlass' => 'Klass' } } - assert_equal expected, @s.cache[:c_class_variables] - - expected = { 'file.c' => { 'sKlass' => 'KlassSingle' } } - assert_equal expected, @s.cache[:c_singleton_class_variables] - - expected = { 'cKlass' => 'Klass' } - assert_equal expected, @s.c_enclosure_names - end - - def test_load_cache_encoding_differs - cache = { - :c_class_variables => {}, - :c_singleton_class_variables => {}, - :encoding => Encoding::ISO_8859_1, - :main => nil, - :methods => { "Object" => %w[Object#method] }, - :modules => %w[Object], - :pages => [], - } - - Dir.mkdir @tmpdir - - File.open File.join(@tmpdir, 'cache.ri'), 'wb' do |io| - Marshal.dump cache, io - end - - @s.encoding = Encoding::UTF_8 - - @s.load_cache - - assert_equal cache, @s.cache - - assert_equal Encoding::UTF_8, @s.encoding - end - - def test_load_cache_no_cache - cache = { - :ancestors => {}, - :attributes => {}, - :class_methods => {}, - :c_class_variables => {}, - :c_singleton_class_variables => {}, - :encoding => nil, - :instance_methods => {}, - :main => nil, - :modules => [], - :pages => [], - :title => nil, - } - - @s.load_cache - - assert_equal cache, @s.cache - end - - def test_load_cache_legacy - cache = { - :ancestors => {}, - :attributes => {}, - :class_methods => {}, - :encoding => :encoding_value, - :instance_methods => { "Object" => %w[Object#method] }, - :modules => %w[Object], - # no :pages - # no :main - # no :c_class_variables - # no :c_singleton_class_variables - } - - Dir.mkdir @tmpdir - - File.open File.join(@tmpdir, 'cache.ri'), 'wb' do |io| - Marshal.dump cache, io - end - - @s.load_cache - - expected = { - :ancestors => {}, - :attributes => {}, - :class_methods => {}, - :c_class_variables => {}, - :c_singleton_class_variables => {}, - :encoding => :encoding_value, - :instance_methods => { "Object" => %w[Object#method] }, - :main => nil, - :modules => %w[Object], - :pages => [], - } - - assert_equal expected, @s.cache - - assert_equal :encoding_value, @s.encoding - assert_nil @s.main - end - - def test_load_class - @s.save_class @klass - @s.classes_hash.clear - - assert_equal @klass, @s.load_class('Object') - - assert_includes @s.classes_hash, 'Object' - end - - def test_load_single_class - @s.save_class @c8_s1 - @s.classes_hash.clear - - assert_equal @c8_s1, @s.load_class('C8::S1') - - assert_includes @s.classes_hash, 'C8::S1' - end - - def test_load_method - @s.save_method @klass, @meth_bang - - meth = @s.load_method('Object', '#method!') - assert_equal @meth_bang, meth - assert_equal @klass, meth.parent - assert_equal @s, meth.store - end - - def test_load_method_legacy - @s.save_method @klass, @meth - - file = @s.method_file @klass.full_name, @meth.full_name - - File.open file, 'wb' do |io| - io.write "\x04\bU:\x14RDoc::AnyMethod[\x0Fi\x00I" + - "\"\vmethod\x06:\x06EF\"\x11Klass#method0:\vpublic" + - "o:\eRDoc::Markup::Document\x06:\v@parts[\x06" + - "o:\x1CRDoc::Markup::Paragraph\x06;\t[\x06I" + - "\"\x16this is a comment\x06;\x06FI" + - "\"\rcall_seq\x06;\x06FI\"\x0Fsome_block\x06;\x06F" + - "[\x06[\aI\"\faliased\x06;\x06Fo;\b\x06;\t[\x06" + - "o;\n\x06;\t[\x06I\"\x12alias comment\x06;\x06FI" + - "\"\nparam\x06;\x06F" - end - - meth = @s.load_method('Object', '#method') - assert_equal 'Klass#method', meth.full_name - assert_equal @klass, meth.parent - assert_equal @s, meth.store - end - - def test_load_page - @s.save_page @page - - assert_equal @page, @s.load_page('README.txt') - end - - def test_main - assert_nil @s.main - - @s.main = 'README.txt' - - assert_equal 'README.txt', @s.main - end - - def test_method_file - assert_equal File.join(@tmpdir, 'Object', 'method-i.ri'), - @s.method_file('Object', 'Object#method') - - assert_equal File.join(@tmpdir, 'Object', 'method%21-i.ri'), - @s.method_file('Object', 'Object#method!') - - assert_equal File.join(@tmpdir, 'Object', 'SubClass', 'method%21-i.ri'), - @s.method_file('Object::SubClass', 'Object::SubClass#method!') - - assert_equal File.join(@tmpdir, 'Object', 'method-c.ri'), - @s.method_file('Object', 'Object::method') - end - - def test_module_names - @s.save_class @klass - - assert_equal %w[Object], @s.module_names - end - - def test_page - page = @store.add_file 'PAGE.txt', parser: RDoc::Parser::Simple - - assert_nil @store.page 'no such page' - - assert_equal page, @store.page('PAGE') - end - - def test_page_with_extension - page = @store.add_file 'PAGE.txt', parser: RDoc::Parser::Simple - - assert_nil @store.page 'no such page' - - assert_equal page, @store.page('PAGE.txt') - end - - def test_save - FileUtils.mkdir_p @tmpdir - - @s.save - - assert_directory File.join(@tmpdir, 'Object') - - assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri') - assert_file File.join(@tmpdir, 'Object', 'method-i.ri') - assert_file File.join(@tmpdir, 'page-README_txt.ri') - - assert_file File.join(@tmpdir, 'cache.ri') - - expected = { - :ancestors => { - 'Object::SubClass' => %w[Incl Object], - }, - :attributes => { 'Object' => ['attr_accessor attr'] }, - :class_methods => { 'Object' => %w[cmethod] }, - :c_class_variables => {}, - :c_singleton_class_variables => {}, - :instance_methods => { - 'Object' => %w[attr method method! method_bang], - 'Object::SubClass' => %w[method], - }, - :main => nil, - :modules => %w[Mod Object Object::SubClass], - :encoding => nil, - :pages => %w[README.txt], - :title => nil, - } - - expected[:ancestors]['Object'] = %w[BasicObject] - - File.open File.join(@tmpdir, 'cache.ri'), 'rb' do |io| - cache = Marshal.load io.read - - assert_equal expected, cache - end - end - - def test_save_cache - @s.save_class @klass - @s.save_method @klass, @meth - @s.save_method @klass, @cmeth - @s.save_class @nest_klass - @s.save_page @page - @s.encoding = :encoding_value - @s.main = @page.full_name - @s.title = 'title' - - options = RDoc::Options.new - - c_file = @s.add_file 'ext.c' - - some_ext = c_file.add_class RDoc::NormalClass, 'SomeExt' - c_file.add_class RDoc::SingleClass, 'SomeExtSingle' - - c_parser = RDoc::Parser::C.new c_file, 'ext.c', '', options, nil - - c_parser.classes['cSomeExt'] = some_ext - c_parser.singleton_classes['s_cSomeExt'] = 'SomeExtSingle' - - @s.add_c_variables c_parser - - @s.save_cache - - assert_file File.join(@tmpdir, 'cache.ri') - - c_class_variables = { - 'ext.c' => { - 'cSomeExt' => 'SomeExt' - } - } - - c_singleton_class_variables = { - 'ext.c' => { - 's_cSomeExt' => 'SomeExtSingle' - } - } - - expected = { - :ancestors => { - 'Object::SubClass' => %w[Incl Object], - }, - :attributes => { 'Object' => ['attr_accessor attr'] }, - :class_methods => { 'Object' => %w[cmethod] }, - :c_class_variables => c_class_variables, - :c_singleton_class_variables => c_singleton_class_variables, - :instance_methods => { - 'Object' => %w[method method! method_bang], - 'Object::SubClass' => %w[method], - }, - :main => @page.full_name, - :modules => %w[Object Object::SubClass], - :encoding => :encoding_value, - :pages => %w[README.txt], - :title => 'title', - } - - expected[:ancestors]['Object'] = %w[BasicObject] - - File.open File.join(@tmpdir, 'cache.ri'), 'rb' do |io| - cache = Marshal.load io.read - - assert_equal expected, cache - end - end - - def test_save_cache_dry_run - @s.dry_run = true - - @s.save_class @klass - @s.save_method @klass, @meth - @s.save_method @klass, @cmeth - @s.save_class @nest_klass - - @s.save_cache - - refute_file File.join(@tmpdir, 'cache.ri') - end - - def test_save_cache_duplicate_methods - @s.save_method @klass, @meth - @s.save_method @klass, @meth - - @s.save_cache - - assert_cache({ 'Object' => %w[method] }, {}, {}, []) - end - - def test_save_cache_duplicate_pages - @s.save_page @page - @s.save_page @page - - @s.save_cache - - assert_cache({}, {}, {}, [], {}, %w[README.txt]) - end - - def test_save_class - @s.save_class @klass - - assert_directory File.join(@tmpdir, 'Object') - assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri') - - assert_cache nil, nil, nil, %w[Object], 'Object' => OBJECT_ANCESTORS - - assert_equal @klass, @s.load_class('Object') - end - - def test_save_class_basic_object - @klass.instance_variable_set :@superclass, nil - - @s.save_class @klass - - assert_directory File.join(@tmpdir, 'Object') - assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri') - - assert_cache(nil, nil, nil, %w[Object]) - - assert_equal @klass, @s.load_class('Object') - end - - def test_save_class_delete - # save original - @s.save_class @klass - @s.save_method @klass, @meth - @s.save_method @klass, @meth_bang - @s.save_method @klass, @cmeth - @s.save_method @klass, @attr - @s.save_cache - - klass = RDoc::NormalClass.new 'Object' - - meth = klass.add_method RDoc::AnyMethod.new(nil, 'replace') - meth.record_location @top_level - - # load original, save newly updated class - @s = RDoc::RI::Store.new @tmpdir - @s.load_cache - @s.save_class klass - @s.save_cache - - # load from disk again - @s = RDoc::RI::Store.new @tmpdir - @s.load_cache - - @s.load_class 'Object' - - assert_cache({ 'Object' => %w[replace] }, {}, - { 'Object' => %w[attr_accessor\ attr] }, %w[Object], - 'Object' => OBJECT_ANCESTORS) - - # assert these files were deleted - refute_file @s.method_file(@klass.full_name, @meth.full_name) - refute_file @s.method_file(@klass.full_name, @meth_bang.full_name) - refute_file @s.method_file(@klass.full_name, @cmeth.full_name) - - # assert these files were not deleted - assert_file @s.method_file(@klass.full_name, @attr.full_name) - end - - def test_save_class_dry_run - @s.dry_run = true - - @s.save_class @klass - - refute_file File.join(@tmpdir, 'Object') - refute_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri') - end - - def test_save_class_loaded - @s.save - - assert_directory File.join(@tmpdir, 'Object') - assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri') - - assert_file @s.method_file(@klass.full_name, @attr.full_name) - assert_file @s.method_file(@klass.full_name, @cmeth.full_name) - assert_file @s.method_file(@klass.full_name, @meth.full_name) - assert_file @s.method_file(@klass.full_name, @meth_bang.full_name) - - s = RDoc::Store.new @s.path - s.load_cache - - loaded = s.load_class 'Object' - - assert_equal @klass, loaded - - s.save_class loaded - - s = RDoc::Store.new @s.path - s.load_cache - - reloaded = s.load_class 'Object' - - assert_equal @klass, reloaded - - # assert these files were not deleted. Bug #171 - assert_file s.method_file(@klass.full_name, @attr.full_name) - assert_file s.method_file(@klass.full_name, @cmeth.full_name) - assert_file s.method_file(@klass.full_name, @meth.full_name) - assert_file s.method_file(@klass.full_name, @meth_bang.full_name) - end - - def test_save_class_merge - @s.save_class @klass - - klass = RDoc::NormalClass.new 'Object' - klass.add_comment 'new comment', @top_level - - s = RDoc::RI::Store.new @tmpdir - s.save_class klass - - s = RDoc::RI::Store.new @tmpdir - - inner = @RM::Document.new @RM::Paragraph.new 'new comment' - inner.file = @top_level - - document = @RM::Document.new inner - - assert_equal document, s.load_class('Object').comment_location - end - - # This is a functional test - def test_save_class_merge_constant - store = RDoc::Store.new - tl = store.add_file 'file.rb' - - klass = tl.add_class RDoc::NormalClass, 'C' - klass.add_comment 'comment', tl - - const = klass.add_constant RDoc::Constant.new('CONST', nil, nil) - const.record_location tl - - @s.save_class klass - - # separate parse run, independent store - store = RDoc::Store.new - tl = store.add_file 'file.rb' - klass2 = tl.add_class RDoc::NormalClass, 'C' - klass2.record_location tl - - s = RDoc::RI::Store.new @tmpdir - s.save_class klass2 - - # separate `ri` run, independent store - s = RDoc::RI::Store.new @tmpdir - - result = s.load_class 'C' - - assert_empty result.constants - end - - def test_save_class_methods - @s.save_class @klass - - assert_directory File.join(@tmpdir, 'Object') - assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri') - - assert_cache nil, nil, nil, %w[Object], 'Object' => OBJECT_ANCESTORS - - assert_equal @klass, @s.load_class('Object') - end - - def test_save_class_nested - @s.save_class @nest_klass - - assert_directory File.join(@tmpdir, 'Object', 'SubClass') - assert_file File.join(@tmpdir, 'Object', 'SubClass', 'cdesc-SubClass.ri') - - assert_cache({ 'Object::SubClass' => %w[method] }, {}, {}, - %w[Object::SubClass], 'Object::SubClass' => %w[Incl Object]) - end - - def test_save_method - @s.save_method @klass, @meth - - assert_directory File.join(@tmpdir, 'Object') - assert_file File.join(@tmpdir, 'Object', 'method-i.ri') - - assert_cache({ 'Object' => %w[method] }, {}, {}, []) - - assert_equal @meth, @s.load_method('Object', '#method') - end - - def test_save_method_dry_run - @s.dry_run = true - - @s.save_method @klass, @meth - - refute_file File.join(@tmpdir, 'Object') - refute_file File.join(@tmpdir, 'Object', 'method-i.ri') - end - - def test_save_method_nested - @s.save_method @nest_klass, @nest_meth - - assert_directory File.join(@tmpdir, 'Object', 'SubClass') - assert_file File.join(@tmpdir, 'Object', 'SubClass', 'method-i.ri') - - assert_cache({ 'Object::SubClass' => %w[method] }, {}, {}, []) - end - - def test_save_page - @s.save_page @page - - assert_file File.join(@tmpdir, 'page-README_txt.ri') - - assert_cache({}, {}, {}, [], {}, %w[README.txt]) - end - - def test_save_page_file - @s.save_page @top_level - - refute_file File.join(@tmpdir, 'page-file_rb.ri') - end - - def test_source - @s.path = @tmpdir - @s.type = nil - assert_equal @s.path, @s.source - - @s.type = :extra - assert_equal @s.path, @s.source - - @s.type = :system - assert_equal "ruby", @s.source - - @s.type = :site - assert_equal "site", @s.source - - @s.type = :home - assert_equal "home", @s.source - - @s.type = :gem - @s.path = "#{@tmpdir}/gem_repository/doc/gem_name-1.0/ri" - assert_equal "gem_name-1.0", @s.source - end - - def test_title - assert_nil @s.title - - @s.title = 'rdoc' - - assert_equal 'rdoc', @s.title - end - -end diff --git a/test/rdoc/test_rdoc_task.rb b/test/rdoc/test_rdoc_task.rb deleted file mode 100644 index 67d223087b..0000000000 --- a/test/rdoc/test_rdoc_task.rb +++ /dev/null @@ -1,182 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' -begin - require 'rake' -rescue LoadError -end - -class TestRDocTask < RDoc::TestCase - - def setup - super - - Rake::Task.clear - - @t = RDoc::Task.new - end - - def test_clobber_task_description - assert_equal 'Remove RDoc HTML files', @t.clobber_task_description - end - - def test_inline_source - _, err = verbose_capture_output do - assert @t.inline_source - end - - assert_equal "RDoc::Task#inline_source is deprecated\n", err - - _, err = verbose_capture_output do - @t.inline_source = false - end - - assert_equal "RDoc::Task#inline_source is deprecated\n", err - - capture_output do - assert @t.inline_source - end - end - - def test_markup_option - rdoc_task = RDoc::Task.new do |rd| - rd.markup = "tomdoc" - end - - assert_equal %w[-o html --markup tomdoc], rdoc_task.option_list - end - - def test_tasks_creation - RDoc::Task.new - assert Rake::Task[:rdoc] - assert Rake::Task[:clobber_rdoc] - assert Rake::Task[:rerdoc] - assert Rake::Task[:"rdoc:coverage"] - assert_equal ["html/created.rid"], Rake::Task[:rdoc].prerequisites - end - - def test_tasks_creation_with_custom_name_symbol - rd = RDoc::Task.new(:rdoc_dev) - assert Rake::Task[:rdoc_dev] - assert Rake::Task[:clobber_rdoc_dev] - assert Rake::Task[:rerdoc_dev] - assert Rake::Task[:"rdoc_dev:coverage"] - assert_equal :rdoc_dev, rd.name - end - - def test_tasks_option_parser - rdoc_task = RDoc::Task.new do |rd| - rd.title = "Test Tasks Option Parser" - rd.main = "README.md" - rd.rdoc_files.include("README.md") - rd.options << "--all" - end - - assert_equal "Test Tasks Option Parser", rdoc_task.title - assert_equal "README.md", rdoc_task.main - assert rdoc_task.rdoc_files.include?("README.md") - assert rdoc_task.options.include?("--all") - - args = %w[--all -o html --main README.md] << "--title" << "Test Tasks Option Parser" << "README.md" - assert_equal args, rdoc_task.option_list + rdoc_task.rdoc_files - end - - def test_generator_option - rdoc_task = RDoc::Task.new do |rd| - rd.generator = "ri" - end - - assert_equal %w[-o html -f ri], rdoc_task.option_list - end - - def test_main_option - rdoc_task = RDoc::Task.new do |rd| - rd.main = "README.md" - end - - assert_equal %w[-o html --main README.md], rdoc_task.option_list - end - - def test_output_dir_option - rdoc_task = RDoc::Task.new do |rd| - rd.rdoc_dir = "zomg" - end - - assert_equal %w[-o zomg], rdoc_task.option_list - end - - def test_rdoc_task_description - assert_equal 'Build RDoc HTML files', @t.rdoc_task_description - end - - def test_rerdoc_task_description - assert_equal 'Rebuild RDoc HTML files', @t.rerdoc_task_description - end - - def test_coverage_task_description - assert_equal 'Print RDoc coverage report', @t.coverage_task_description - end - - def test_tasks_creation_with_custom_name_string - rd = RDoc::Task.new("rdoc_dev") - assert Rake::Task[:rdoc_dev] - assert Rake::Task[:clobber_rdoc_dev] - assert Rake::Task[:rerdoc_dev] - assert Rake::Task[:"rdoc_dev:coverage"] - assert_equal "rdoc_dev", rd.name - end - - def test_tasks_creation_with_custom_name_hash - options = { - :rdoc => "rdoc", - :clobber_rdoc => "rdoc:clean", - :rerdoc => "rdoc:force" - } - - Rake::Task.clear - - rd = RDoc::Task.new(options) - assert Rake::Task[:"rdoc"] - assert Rake::Task[:"rdoc:clean"] - assert Rake::Task[:"rdoc:force"] - assert Rake::Task[:"rdoc:coverage"] - assert_raise(RuntimeError) { Rake::Task[:clobber_rdoc] } - assert_equal options, rd.name - end - - def test_tasks_creation_with_custom_name_hash_will_use_default_if_an_option_isnt_given - RDoc::Task.new(:clobber_rdoc => "rdoc:clean") - assert Rake::Task[:rdoc] - assert Rake::Task[:"rdoc:clean"] - assert Rake::Task[:rerdoc] - assert Rake::Task[:"rdoc:coverage"] - end - - def test_tasks_creation_with_custom_name_hash_raises_exception_if_invalid_option_given - assert_raise(ArgumentError) do - RDoc::Task.new(:foo => "bar") - end - - begin - RDoc::Task.new(:foo => "bar") - rescue ArgumentError => e - assert_match(/foo/, e.message) - end - end - - def test_template_option - rdoc_task = RDoc::Task.new do |rd| - rd.template = "foo" - end - - assert_equal %w[-o html -T foo], rdoc_task.option_list - end - - def test_title_option - rdoc_task = RDoc::Task.new do |rd| - rd.title = "Test Title Option" - end - - assert_equal %w[-o html] << "--title" << "Test Title Option", rdoc_task.option_list - end - -end if defined?(Rake::Task) diff --git a/test/rdoc/test_rdoc_text.rb b/test/rdoc/test_rdoc_text.rb deleted file mode 100644 index a6b1597bbf..0000000000 --- a/test/rdoc/test_rdoc_text.rb +++ /dev/null @@ -1,585 +0,0 @@ -# frozen_string_literal: true - -require_relative 'helper' -require 'timeout' - -class TestRDocText < RDoc::TestCase - - include RDoc::Text - - def setup - super - - @options = RDoc::Options.new - - @top_level = @store.add_file 'file.rb' - @language = nil - end - - def test_self_encode_fallback - assert_equal '…', - RDoc::Text::encode_fallback('…', Encoding::UTF_8, '...') - assert_equal '...', - RDoc::Text::encode_fallback('…', Encoding::US_ASCII, '...') - end - - def test_expand_tabs - assert_equal("hello\n dave", - expand_tabs("hello\n dave"), 'spaces') - - assert_equal("hello\n dave", - expand_tabs("hello\n\tdave"), 'tab') - - assert_equal("hello\n dave", - expand_tabs("hello\n \tdave"), '1 space tab') - - assert_equal("hello\n dave", - expand_tabs("hello\n \tdave"), '2 space tab') - - assert_equal("hello\n dave", - expand_tabs("hello\n \tdave"), '3 space tab') - - assert_equal("hello\n dave", - expand_tabs("hello\n \tdave"), '4 space tab') - - assert_equal("hello\n dave", - expand_tabs("hello\n \tdave"), '5 space tab') - - assert_equal("hello\n dave", - expand_tabs("hello\n \tdave"), '6 space tab') - - assert_equal("hello\n dave", - expand_tabs("hello\n \tdave"), '7 space tab') - - assert_equal("hello\n dave", - expand_tabs("hello\n \tdave"), '8 space tab') - - assert_equal('. .', - expand_tabs(".\t\t."), 'dot tab tab dot') - - assert_equal('a a', - Timeout.timeout(1) {expand_tabs("\ra\ta")}, "carriage return") - end - - def test_expand_tabs_encoding - inn = "hello\ns\tdave" - inn = RDoc::Encoding.change_encoding inn, Encoding::BINARY - - out = expand_tabs inn - - assert_equal "hello\ns dave", out - assert_equal Encoding::BINARY, out.encoding - end - - def test_flush_left - text = <<-TEXT - - we don't worry too much. - - The comments associated with - TEXT - - expected = <<-EXPECTED - -we don't worry too much. - -The comments associated with - EXPECTED - - assert_equal expected, flush_left(text) - end - - def test_flush_left_encoding - text = <<-TEXT - - we don't worry too much. - - The comments associated with - TEXT - - text = RDoc::Encoding.change_encoding text, Encoding::US_ASCII - - expected = <<-EXPECTED - -we don't worry too much. - -The comments associated with - EXPECTED - - result = flush_left text - - assert_equal expected, result - assert_equal Encoding::US_ASCII, result.encoding - end - - def test_markup_string - out = markup('hi').gsub("\n", '') - - assert_equal '<p>hi</p>', out - end - - def test_markup_comment - out = markup(comment('hi')).gsub("\n", '') - - assert_equal '<p>hi</p>', out - end - - def test_normalize_comment_hash - text = <<-TEXT -## -# we don't worry too much. -# -# The comments associated with - TEXT - - expected = <<-EXPECTED.rstrip -we don't worry too much. - -The comments associated with - EXPECTED - - @language = :ruby - - assert_equal expected, normalize_comment(text) - end - - def test_normalize_comment_stars_single_space - text = <<-TEXT -/* - * we don't worry too much. - * - * The comments associated with - */ - TEXT - - expected = <<-EXPECTED.rstrip -we don't worry too much. - -The comments associated with - EXPECTED - - @language = :c - - assert_equal expected, normalize_comment(text) - end - - def test_normalize_comment_stars_single_double_space - text = <<-TEXT -/* - * we don't worry too much. - * - * The comments associated with - */ - TEXT - - expected = <<-EXPECTED.rstrip -we don't worry too much. - -The comments associated with - EXPECTED - - @language = :c - - assert_equal expected, normalize_comment(text) - end - - def test_parse - assert_kind_of RDoc::Markup::Document, parse('hi') - end - - def test_parse_comment - expected = RDoc::Markup::Document.new - expected.file = @top_level - - c = comment '' - parsed = parse c - - assert_equal expected, parsed - assert_same parsed, parse(c) - end - - def test_parse_document - assert_equal RDoc::Markup::Document.new, parse(RDoc::Markup::Document.new) - end - - def test_parse_empty - assert_equal RDoc::Markup::Document.new, parse('') - end - - def test_parse_empty_newline - @language = :ruby - - assert_equal RDoc::Markup::Document.new, parse("#\n") - end - - def test_parse_format_markdown - expected = - @RM::Document.new( - @RM::Paragraph.new('it _works_')) - - parsed = parse 'it *works*', 'markdown' - - assert_equal expected, parsed - end - - def test_parse_format_rd - expected = - @RM::Document.new( - @RM::Paragraph.new('it <em>works</em>')) - - parsed = parse 'it ((*works*))', 'rd' - - assert_equal expected, parsed - end - - def test_parse_format_tomdoc - code = verb('1 + 1') - code.format = :ruby - - expected = - doc( - para('It does a thing'), - blank_line, - head(3, 'Examples'), - blank_line, - code) - - text = <<-TOMDOC -It does a thing - -Examples - - 1 + 1 - TOMDOC - - parsed = parse text, 'tomdoc' - - assert_equal expected, parsed - end - - def test_parse_newline - assert_equal RDoc::Markup::Document.new, parse("\n") - end - - def test_snippet - text = <<-TEXT -This is one-hundred characters or more of text in a single paragraph. This -paragraph will be cut off some point after the one-hundredth character. - TEXT - - expected = <<-EXPECTED -<p>This is one-hundred characters or more of text in a single paragraph. This paragraph will be cut off … - EXPECTED - - assert_equal expected, snippet(text) - end - - def test_snippet_comment - c = comment 'This is a comment' - - assert_equal "<p>This is a comment\n", snippet(c) - end - - def test_snippet_short - text = 'This is a comment' - - assert_equal "<p>#{text}\n", snippet(text) - end - - def test_strip_hashes - text = <<-TEXT -## -# we don't worry too much. -# -# The comments associated with - TEXT - - expected = <<-EXPECTED - - we don't worry too much. - - The comments associated with - EXPECTED - - assert_equal expected, strip_hashes(text) - end - - def test_strip_hashes_encoding - text = <<-TEXT -## -# we don't worry too much. -# -# The comments associated with - TEXT - - text = RDoc::Encoding.change_encoding text, Encoding::CP852 - - expected = <<-EXPECTED - - we don't worry too much. - - The comments associated with - EXPECTED - - stripped = strip_hashes text - - assert_equal expected, stripped - assert_equal Encoding::CP852, stripped.encoding - end - - def test_strip_newlines - assert_equal ' ', strip_newlines("\n \n") - - assert_equal 'hi', strip_newlines("\n\nhi") - - assert_equal 'hi', strip_newlines( "hi\n\n") - - assert_equal 'hi', strip_newlines("\n\nhi\n\n") - end - - def test_strip_newlines_encoding - assert_equal Encoding::UTF_8, ''.encoding, 'Encoding sanity check' - - text = " \n" - text = RDoc::Encoding.change_encoding text, Encoding::US_ASCII - - stripped = strip_newlines text - - assert_equal ' ', stripped - - assert_equal Encoding::US_ASCII, stripped.encoding - end - - def test_strip_stars - text = <<-TEXT -/* - * * we don't worry too much. - * - * The comments associated with - */ - TEXT - - expected = <<-EXPECTED - - * we don't worry too much. - - The comments associated with - EXPECTED - - assert_equal expected, strip_stars(text) - end - - def test_strip_stars_document_method - text = <<-TEXT -/* - * Document-method: Zlib::GzipFile#mtime= - * - * A comment - */ - TEXT - - expected = <<-EXPECTED - - A comment - EXPECTED - - assert_equal expected, strip_stars(text) - end - - def test_strip_stars_document_method_special - text = <<-TEXT -/* - * Document-method: Zlib::GzipFile#mtime= - * Document-method: [] - * Document-method: ` - * Document-method: | - * Document-method: & - * Document-method: <=> - * Document-method: =~ - * Document-method: + - * Document-method: - - * Document-method: +@ - * - * A comment - */ - TEXT - - expected = <<-EXPECTED - - A comment - EXPECTED - - assert_equal expected, strip_stars(text) - end - - def test_strip_stars_encoding - text = <<-TEXT -/* - * * we don't worry too much. - * - * The comments associated with - */ - TEXT - - text = RDoc::Encoding.change_encoding text, Encoding::CP852 - - expected = <<-EXPECTED - - * we don't worry too much. - - The comments associated with - EXPECTED - - result = strip_stars text - - assert_equal expected, result - assert_equal Encoding::CP852, result.encoding - end - - def test_strip_stars_encoding2 - text = <<-TEXT -/* - * * we don't worry too much. - * - * The comments associated with - */ - TEXT - - text = RDoc::Encoding.change_encoding text, Encoding::BINARY - - expected = <<-EXPECTED - - * we don't worry too much. - - The comments associated with - EXPECTED - - result = strip_stars text - - assert_equal expected, result - assert_equal Encoding::BINARY, result.encoding - end - - def test_strip_stars_no_stars - text = <<-TEXT -* we don't worry too much. - -The comments associated with - - TEXT - - expected = <<-EXPECTED -* we don't worry too much. - -The comments associated with - - EXPECTED - - assert_equal expected, strip_stars(text) - end - - def test_to_html_apostrophe - assert_equal '‘a', to_html("'a") - assert_equal 'a’', to_html("a'") - - assert_equal '‘a’ ‘', to_html("'a' '") - end - - def test_to_html_apostrophe_entity - assert_equal '‘a', to_html("'a") - assert_equal 'a’', to_html("a'") - - assert_equal '‘a’ ‘', to_html("'a' '") - end - - def test_to_html_backslash - assert_equal 'S', to_html('\\S') - end - - def test_to_html_br - assert_equal '<br>', to_html('<br>') - end - - def test_to_html_copyright - assert_equal '©', to_html('(c)') - assert_equal '©', to_html('(C)') - end - - def test_to_html_dash - assert_equal '-', to_html('-') - assert_equal '–', to_html('--') - assert_equal '—', to_html('---') - assert_equal '—-', to_html('----') - end - - def test_to_html_double_backtick - assert_equal '“a', to_html('``a') - assert_equal '“a“', to_html('``a``') - assert_equal '“a”', to_html("``a''") - end - - def test_to_html_double_quote - assert_equal '“a', to_html('"a') - assert_equal '“a”', to_html('"a"') - end - - def test_to_html_double_quote_quot - assert_equal '“a', to_html('"a') - assert_equal '“a”', to_html('"a"') - end - - def test_to_html_double_tick - assert_equal '”a', to_html("''a") - assert_equal '”a”', to_html("''a''") - end - - def test_to_html_ellipsis - assert_equal '..', to_html('..') - assert_equal '…', to_html('...') - assert_equal '.…', to_html('....') - end - - def test_to_html_encoding - s = '...(c)'.encode Encoding::Shift_JIS - - html = to_html s - - assert_equal Encoding::Shift_JIS, html.encoding - - expected = '…(c)'.encode Encoding::Shift_JIS - - assert_equal expected, html - end - - def test_to_html_html_tag - assert_equal '<a href="http://example">hi’s</a>', - to_html('<a href="http://example">hi\'s</a>') - end - - def test_to_html_registered_trademark - assert_equal '®', to_html('(r)') - assert_equal '®', to_html('(R)') - end - - def test_to_html_tt_tag - assert_equal '<tt>hi\'s</tt>', to_html('<tt>hi\'s</tt>') - assert_equal '<tt>hi\\\'s</tt>', to_html('<tt>hi\\\\\'s</tt>') - end - - def test_to_html_tt_tag_mismatch - _, err = verbose_capture_output do - assert_equal '<tt>hi', to_html('<tt>hi') - end - - assert_equal "mismatched <tt> tag\n", err - end - - def formatter - RDoc::Markup::ToHtml.new @options - end - - def options - @options - end - -end diff --git a/test/rdoc/test_rdoc_token_stream.rb b/test/rdoc/test_rdoc_token_stream.rb deleted file mode 100644 index 8fcd3d8f68..0000000000 --- a/test/rdoc/test_rdoc_token_stream.rb +++ /dev/null @@ -1,109 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocTokenStream < RDoc::TestCase - - def test_class_to_html - tokens = [ - { :line_no => 0, :char_no => 0, :kind => :on_const, :text => 'CONSTANT' }, - { :line_no => 0, :char_no => 0, :kind => :on_kw, :text => 'KW' }, - { :line_no => 0, :char_no => 0, :kind => :on_ivar, :text => 'IVAR' }, - { :line_no => 0, :char_no => 0, :kind => :on_op, :text => 'Op' }, - { :line_no => 0, :char_no => 0, :kind => :on_ident, :text => 'Id' }, - { :line_no => 0, :char_no => 0, :kind => :on_backref, :text => 'Node' }, - { :line_no => 0, :char_no => 0, :kind => :on_comment, :text => 'COMMENT' }, - { :line_no => 0, :char_no => 0, :kind => :on_regexp, :text => 'REGEXP' }, - { :line_no => 0, :char_no => 0, :kind => :on_tstring, :text => 'STRING' }, - { :line_no => 0, :char_no => 0, :kind => :on_int, :text => 'Val' }, - { :line_no => 0, :char_no => 0, :kind => :on_unknown, :text => '\\' } - ] - - expected = [ - '<span class="ruby-constant">CONSTANT</span>', - '<span class="ruby-keyword">KW</span>', - '<span class="ruby-ivar">IVAR</span>', - '<span class="ruby-operator">Op</span>', - '<span class="ruby-identifier">Id</span>', - '<span class="ruby-node">Node</span>', - '<span class="ruby-comment">COMMENT</span>', - '<span class="ruby-regexp">REGEXP</span>', - '<span class="ruby-string">STRING</span>', - '<span class="ruby-value">Val</span>', - '\\' - ].join - - assert_equal expected, RDoc::TokenStream.to_html(tokens) - end - - def test_class_to_html_empty - assert_equal '', RDoc::TokenStream.to_html([]) - end - - def test_add_tokens - foo = Class.new do - include RDoc::TokenStream - end.new - foo.collect_tokens - foo.add_tokens([:token]) - assert_equal [:token], foo.token_stream - end - - def test_add_token - foo = Class.new do - include RDoc::TokenStream - end.new - foo.collect_tokens - foo.add_token(:token) - assert_equal [:token], foo.token_stream - end - - def test_collect_tokens - foo = Class.new do - include RDoc::TokenStream - end.new - foo.collect_tokens - assert_equal [], foo.token_stream - end - - def test_pop_token - foo = Class.new do - include RDoc::TokenStream - end.new - foo.collect_tokens - foo.add_token(:token) - foo.pop_token - assert_equal [], foo.token_stream - end - - def test_token_stream - foo = Class.new do - include RDoc::TokenStream - end.new - assert_equal nil, foo.token_stream - end - - def test_tokens_to_s - foo = Class.new do - include RDoc::TokenStream - - def initialize - @token_stream = [ - { line_no: 0, char_no: 0, kind: :on_ident, text: "foo" }, - { line_no: 0, char_no: 0, kind: :on_sp, text: " " }, - { line_no: 0, char_no: 0, kind: :on_tstring, text: "'bar'" }, - ] - end - end.new - - assert_equal "foo 'bar'", foo.tokens_to_s - - foo = Class.new do - include RDoc::TokenStream - - def initialize - @token_stream = nil - end - end.new - assert_equal "", foo.tokens_to_s - end -end diff --git a/test/rdoc/test_rdoc_tom_doc.rb b/test/rdoc/test_rdoc_tom_doc.rb deleted file mode 100644 index ddecea4b21..0000000000 --- a/test/rdoc/test_rdoc_tom_doc.rb +++ /dev/null @@ -1,579 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocTomDoc < RDoc::TestCase - - def setup - super - - @top_level = @store.add_file 'file.rb' - - @TD = RDoc::TomDoc - @td = @TD.new - end - - def test_class_add_post_processor - RDoc::TomDoc.add_post_processor - - pp = RDoc::Markup::PreProcess.new __FILE__, [] - - text = "# Public: Do some stuff\n" - - comment = RDoc::Comment.new text, nil - comment.format = 'tomdoc' - - parent = RDoc::Context.new - - pp.handle comment, parent - - method = parent.add_method RDoc::AnyMethod.new(nil, 'm') - - assert_equal 'Public', method.section.title - assert_equal "# Do some stuff\n", comment.text - end - - def test_class_signature - c = comment <<-COMMENT -Signature - - method_<here>(args) - -here - something - COMMENT - c.format = 'tomdoc' - - signature = @TD.signature c - - assert_equal "method_<here>(args)\n", signature - end - - def test_class_signature_no_space - c = comment <<-COMMENT -Signature - method_<here>(args) - -here - something - COMMENT - c.format = 'tomdoc' - - signature = @TD.signature c - - assert_equal "method_<here>(args)\n", signature - - expected = - doc( - head(3, 'Signature'), - list(:NOTE, - item(%w[here], - para('something')))) - expected.file = @top_level - - assert_equal expected, c.parse - end - - def test_class_signature_none - c = comment '' - c.format = 'tomdoc' - - assert_nil @TD.signature c - end - - def test_class_rdoc - c = comment <<-COMMENT -=== Signature - - method_<here>(args) - -here - something - COMMENT - c.format = 'rdoc' - - signature = @TD.signature c - - assert_nil signature - end - - def test_class_signature_two_space - c = comment <<-COMMENT -Signature - - - method_<here>(args) - -here - something - COMMENT - c.format = 'tomdoc' - - signature = @TD.signature c - - assert_equal "method_<here>(args)\n", signature - - expected = - doc( - head(3, 'Signature'), - list(:NOTE, - item(%w[here], - para('something')))) - expected.file = @top_level - - assert_equal expected, c.parse - end - - def test_parse_paragraph - text = "Public: Do some stuff\n" - - expected = - @RM::Document.new( - @RM::Paragraph.new('Do some stuff')) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_multiline_paragraph - text = "Public: Do some stuff\n" - text += "On a new line\n" - - expected = - doc( - para('Do some stuff', ' ', 'On a new line')) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_arguments - text = <<-TEXT -Create new Arg object. - -name - name of argument -description - arguments description - TEXT - - expected = - doc( - para('Create new Arg object.'), - blank_line, - list(:NOTE, - item(%w[name], - para('name of argument')), - item(%w[description], - para('arguments description')))) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_arguments_array - text = <<-TEXT -Create new Arg object. - -names[] - names of arguments - TEXT - - expected = - doc( - para('Create new Arg object.'), - blank_line, - list(:NOTE, - item(%w[names[]], - para('names of arguments')))) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_arguments_multiline - text = <<-TEXT -Do some stuff - -foo - A comment goes here - and is more than one line - TEXT - - expected = - doc( - para('Do some stuff'), - blank_line, - list(:NOTE, - item(%w[foo], - para('A comment goes here', ' ', 'and is more than one line')))) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_arguments_nested - text = <<-TEXT -Do some stuff - -foo - A comment goes here - :bar - bar documentation - TEXT - - expected = - doc( - para('Do some stuff'), - blank_line, - list(:NOTE, - item(%w[foo], - para('A comment goes here'), - list(:NOTE, - item(%w[:bar], - para('bar documentation')))))) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_examples - text = <<-TEXT -Do some stuff - -Examples - - 1 + 1 - TEXT - - code = verb("1 + 1\n") - code.format = :ruby - - expected = - doc( - para('Do some stuff'), - blank_line, - head(3, 'Examples'), - blank_line, - code) - - document = @TD.parse(text) - assert_equal expected, document - assert document.parts.last.ruby? - end - - def test_parse_examples_signature - text = <<-TEXT -Do some stuff - -Examples - - 1 + 1 - -Signature - - foo(args) - TEXT - - code1 = verb("1 + 1\n") - code1.format = :ruby - - code2 = verb("foo(args)\n") - - expected = - doc( - para('Do some stuff'), - blank_line, - head(3, 'Examples'), - blank_line, - code1, - head(3, 'Signature'), - blank_line, - code2) - - document = @TD.parse text - - assert_equal expected, document - end - - def test_parse_returns - text = <<-TEXT -Do some stuff - -Returns a thing - -Returns another thing - TEXT - - expected = - doc( - para('Do some stuff'), - blank_line, - head(3, 'Returns'), - blank_line, - para('Returns a thing'), - blank_line, - para('Returns another thing')) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_returns_with_raises - text = <<-TEXT -Do some stuff - -Returns a thing -Raises ArgumentError when stuff -Raises StandardError when stuff - TEXT - expected = - doc( - para('Do some stuff'), - blank_line, - head(3, 'Returns'), - blank_line, - para('Returns a thing'), - para('Raises ArgumentError when stuff'), - para('Raises StandardError when stuff')) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_raises_without_returns - text = <<-TEXT -Do some stuff - -Raises ArgumentError when stuff - TEXT - expected = - doc( - para('Do some stuff'), - blank_line, - head(3, 'Returns'), - blank_line, - para('Raises ArgumentError when stuff')) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_returns_multiline - text = <<-TEXT -Do some stuff - -Returns a thing - that is multiline - TEXT - - expected = - doc( - para('Do some stuff'), - blank_line, - head(3, 'Returns'), - blank_line, - para('Returns a thing', ' ', 'that is multiline')) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_returns_multiline_and_raises - text = <<-TEXT -Do some stuff - -Returns a thing - that is multiline -Raises ArgumentError - TEXT - - expected = - doc( - para('Do some stuff'), - blank_line, - head(3, 'Returns'), - blank_line, - para('Returns a thing', ' ', 'that is multiline'), - para('Raises ArgumentError')) - - assert_equal expected, @TD.parse(text) - end - - def test_parse_signature - text = <<-TEXT -Do some stuff - -Signature - - some_method(args) - TEXT - - expected = - @RM::Document.new( - @RM::Paragraph.new('Do some stuff'), - @RM::BlankLine.new, - @RM::Heading.new(3, 'Signature'), - @RM::BlankLine.new, - @RM::Verbatim.new("some_method(args)\n")) - - assert_equal expected, @TD.parse(text) - end - - def test_tokenize_paragraph - @td.tokenize "Public: Do some stuff\n" - - expected = [ - [:TEXT, "Do some stuff", 0, 0], - [:NEWLINE, "\n", 13, 0], - ] - - assert_equal expected, @td.tokens - end - - def test_tokenize_multiline_paragraph - text = "Public: Do some stuff\n" - text += "On a new line\n" - - @td.tokenize text - - expected = [ - [:TEXT, "Do some stuff", 0, 0], - [:NEWLINE, "\n", 13, 0], - [:TEXT, "On a new line", 0, 1], - [:NEWLINE, "\n", 13, 1] - ] - - assert_equal expected, @td.tokens - end - - def test_tokenize_arguments - @td.tokenize <<-TEXT -Create new Arg object. - -name - name of argument -description - arguments description - TEXT - - expected = [ - [:TEXT, "Create new Arg object.", 0, 0], - [:NEWLINE, "\n", 22, 0], - [:NEWLINE, "\n", 0, 1], - [:NOTE, "name", 0, 2], - [:TEXT, "name of argument", 14, 2], - [:NEWLINE, "\n", 30, 2], - [:NOTE, "description", 0, 3], - [:TEXT, "arguments description", 14, 3], - [:NEWLINE, "\n", 35, 3], - ] - - assert_equal expected, @td.tokens - end - - def test_tokenize_arguments_array - @td.tokenize <<-TEXT -Create new Arg object. - -names[stuff] - names of arguments - TEXT - - expected = [ - [:TEXT, "Create new Arg object.", 0, 0], - [:NEWLINE, "\n", 22, 0], - [:NEWLINE, "\n", 0, 1], - [:NOTE, "names[stuff]", 0, 2], - [:TEXT, "names of arguments", 15, 2], - [:NEWLINE, "\n", 33, 2], - ] - - assert_equal expected, @td.tokens - end - - def test_tokenize_arguments_multiline - @td.tokenize <<-TEXT -Do some stuff - -foo - A comment goes here - and is more than one line - TEXT - - expected = [ - [:TEXT, "Do some stuff", 0, 0], - [:NEWLINE, "\n", 13, 0], - [:NEWLINE, "\n", 0, 1], - [:NOTE, "foo", 0, 2], - [:TEXT, "A comment goes here", 6, 2], - [:NEWLINE, "\n", 25, 2], - [:TEXT, "and is more than one line", 2, 3], - [:NEWLINE, "\n", 27, 3], - ] - - assert_equal expected, @td.tokens - end - - def test_tokenize_arguments_nested - @td.tokenize <<-TEXT -Do some stuff - -foo - A comment goes here - :bar - bar documentation - TEXT - - expected = [ - [:TEXT, "Do some stuff", 0, 0], - [:NEWLINE, "\n", 13, 0], - [:NEWLINE, "\n", 0, 1], - [:NOTE, "foo", 0, 2], - [:TEXT, "A comment goes here", 6, 2], - [:NEWLINE, "\n", 25, 2], - [:NOTE, ":bar", 6, 3], - [:TEXT, "bar documentation", 13, 3], - [:NEWLINE, "\n", 30, 3], - ] - - assert_equal expected, @td.tokens - end - - def test_tokenize_examples - @td.tokenize <<-TEXT -Do some stuff - -Examples - - 1 + 1 - TEXT - - expected = [ - [:TEXT, "Do some stuff", 0, 0], - [:NEWLINE, "\n", 13, 0], - [:NEWLINE, "\n", 0, 1], - [:HEADER, 3, 0, 2], - [:TEXT, "Examples", 0, 2], - [:NEWLINE, "\n", 8, 2], - [:NEWLINE, "\n", 0, 3], - [:TEXT, "1 + 1", 2, 4], - [:NEWLINE, "\n", 7, 4], - ] - - assert_equal expected, @td.tokens - end - - def test_tokenize_returns - @td.tokenize <<-TEXT -Do some stuff - -Returns a thing - TEXT - - expected = [ - [:TEXT, "Do some stuff", 0, 0], - [:NEWLINE, "\n", 13, 0], - [:NEWLINE, "\n", 0, 1], - [:TEXT, "Returns a thing", 0, 2], - [:NEWLINE, "\n", 15, 2], - ] - - assert_equal expected, @td.tokens - end - - def test_tokenize_returns_multiline - @td.tokenize <<-TEXT -Do some stuff - -Returns a thing - that is multiline - TEXT - - expected = [ - [:TEXT, "Do some stuff", 0, 0], - [:NEWLINE, "\n", 13, 0], - [:NEWLINE, "\n", 0, 1], - [:TEXT, "Returns a thing", 0, 2], - [:NEWLINE, "\n", 15, 2], - [:TEXT, "that is multiline", 2, 3], - [:NEWLINE, "\n", 19, 3], - ] - - assert_equal expected, @td.tokens - end - -end diff --git a/test/rdoc/test_rdoc_top_level.rb b/test/rdoc/test_rdoc_top_level.rb deleted file mode 100644 index 3cfaa9b763..0000000000 --- a/test/rdoc/test_rdoc_top_level.rb +++ /dev/null @@ -1,290 +0,0 @@ -# frozen_string_literal: true -require_relative 'xref_test_case' - -class TestRDocTopLevel < XrefTestCase - - def setup - super - - @top_level = @store.add_file 'path/top_level.rb' - @top_level.parser = RDoc::Parser::Ruby - end - - def test_initialize - t = RDoc::TopLevel.new 'path/file.rb' - - assert_equal 'path/file.rb', t.absolute_name - assert_equal 'path/file.rb', t.relative_name - end - - def test_initialize_relative - t = RDoc::TopLevel.new 'path/file.rb', 'file.rb' - - assert_equal 'path/file.rb', t.absolute_name - assert_equal 'file.rb', t.relative_name - end - - def test_add_alias - a = RDoc::Alias.new nil, 'old', 'new', nil - @top_level.add_alias a - - object = @store.find_class_named 'Object' - expected = { '#old' => [a] } - assert_equal expected, object.unmatched_alias_lists - assert_includes object.in_files, @top_level - end - - def test_add_alias_nodoc - @top_level.document_self = false - - a = RDoc::Alias.new nil, 'old', 'new', nil - @top_level.add_alias a - - object = @store.find_class_named('Object') - assert_empty object.unmatched_alias_lists - assert_includes object.in_files, @top_level - end - - def test_add_constant - const = RDoc::Constant.new 'C', nil, nil - @top_level.add_constant const - - object = @store.find_class_named 'Object' - assert_equal [const], object.constants - assert_includes object.in_files, @top_level - end - - def test_add_constant_nodoc - @top_level.document_self = false - - const = RDoc::Constant.new 'C', nil, nil - @top_level.add_constant const - - object = @store.find_class_named 'Object' - assert_empty object.constants - assert_includes object.in_files, @top_level - end - - def test_add_include - include = RDoc::Include.new 'C', nil - @top_level.add_include include - - object = @store.find_class_named 'Object' - assert_equal [include], object.includes - assert_includes object.in_files, @top_level - end - - def test_add_include_nodoc - @top_level.document_self = false - - include = RDoc::Include.new 'C', nil - @top_level.add_include include - - object = @store.find_class_named('Object') - assert_empty object.includes - assert_includes object.in_files, @top_level - end - - def test_add_method - method = RDoc::AnyMethod.new nil, 'm' - @top_level.add_method method - - object = @store.find_class_named 'Object' - assert_equal [@c10_method, @c11_method, method], object.method_list - assert_includes object.in_files, @top_level - end - - def test_add_method_stopdoc - @top_level.document_self = false - - method = RDoc::AnyMethod.new nil, 'm' - @top_level.add_method method - - object = @store.find_class_named('Object') - assert_equal [@c10_method, @c11_method], object.method_list - assert_includes object.in_files, @top_level - end - - def test_base_name - assert_equal 'top_level.rb', @top_level.base_name - end - - def test_display_eh - refute @top_level.display? - - page = @store.add_file 'README.txt' - page.parser = RDoc::Parser::Simple - - assert page.display? - end - - def test_eql_eh - top_level2 = @store.add_file 'path/top_level.rb' - other_level = @store.add_file 'path/other_level.rb' - - assert_operator @top_level, :eql?, top_level2 - - refute_operator other_level, :eql?, @top_level - end - - def test_equals2 - top_level2 = @store.add_file 'path/top_level.rb' - other_level = @store.add_file 'path/other_level.rb' - - assert_equal @top_level, top_level2 - - refute_equal other_level, @top_level - end - - def test_find_class_or_module - assert_equal @c1, @xref_data.find_class_or_module('C1') - assert_equal @c2_c3, @xref_data.find_class_or_module('C2::C3') - assert_equal @c4, @xref_data.find_class_or_module('C4') - assert_equal @m1_m2, @xref_data.find_class_or_module('M1::M2') - end - - def test_full_name - assert_equal 'path/top_level.rb', @top_level.full_name - end - - def test_hash - tl2 = @store.add_file 'path/top_level.rb' - tl3 = @store.add_file 'other/top_level.rb' - - assert_equal @top_level.hash, tl2.hash - refute_equal @top_level.hash, tl3.hash - end - - def test_http_url - assert_equal 'prefix/path/top_level_rb.html', @top_level.http_url('prefix') - - other_level = @store.add_file 'path.other/level.rb' - assert_equal 'prefix/path_other/level_rb.html', other_level.http_url('prefix') - end - - def test_last_modified - assert_nil @top_level.last_modified - stat = Object.new - def stat.mtime() 0 end - @top_level.file_stat = stat - assert_equal 0, @top_level.last_modified - end - - def test_marshal_dump - page = @store.add_file 'README.txt' - page.parser = RDoc::Parser::Simple - page.comment = RDoc::Comment.new 'This is a page', page - - loaded = Marshal.load Marshal.dump page - - comment = RDoc::Markup::Document.new( - RDoc::Markup::Paragraph.new('This is a page')) - comment.file = loaded - - assert_equal page, loaded - - assert_equal 'README.txt', loaded.absolute_name - assert_equal 'README.txt', loaded.relative_name - - assert_equal RDoc::Parser::Simple, loaded.parser - - assert_equal comment, loaded.comment - end - - def test_marshal_load_version_0 - loaded = Marshal.load "\x04\bU:\x13RDoc::TopLevel" + - "[\ti\x00I\"\x0FREADME.txt\x06:\x06EF" + - "c\x19RDoc::Parser::Simple" + - "o:\eRDoc::Markup::Document\a:\v@parts" + - "[\x06o:\x1CRDoc::Markup::Paragraph\x06;\b" + - "[\x06I\"\x13This is a page\x06;\x06F:\n@file@\a" - - comment = RDoc::Markup::Document.new( - RDoc::Markup::Paragraph.new('This is a page')) - comment.file = loaded - - assert_equal 'README.txt', loaded.absolute_name - assert_equal 'README.txt', loaded.relative_name - - assert_equal RDoc::Parser::Simple, loaded.parser - - assert_equal comment, loaded.comment - - assert loaded.display? - end - - def test_name - assert_equal 'top_level.rb', @top_level.name - end - - def test_page_name - assert_equal 'top_level', @top_level.page_name - - tl = @store.add_file 'README.ja' - - assert_equal 'README.ja', tl.page_name - - tl = @store.add_file 'Rakefile' - - assert_equal 'Rakefile', tl.page_name - end - - def test_page_name_trim_extension - tl = @store.add_file 'README.ja.rdoc' - - assert_equal 'README.ja', tl.page_name - - tl = @store.add_file 'README.ja.md' - - assert_equal 'README.ja', tl.page_name - - tl = @store.add_file 'README.txt' - - assert_equal 'README', tl.page_name - end - - def test_search_record - assert_nil @xref_data.search_record - end - - def test_search_record_page - page = @store.add_file 'README.txt' - page.parser = RDoc::Parser::Simple - page.comment = 'This is a comment.' - - expected = [ - 'README', - '', - 'README', - '', - 'README_txt.html', - '', - "<p>This is a comment.\n", - ] - - assert_equal expected, page.search_record - end - - def test_text_eh - refute @xref_data.text? - - rd = @store.add_file 'rd_format.rd' - rd.parser = RDoc::Parser::RD - - assert rd.text? - - simple = @store.add_file 'simple.txt' - simple.parser = RDoc::Parser::Simple - - assert simple.text? - end - - def test_text_eh_no_parser - refute @xref_data.text? - - rd = @store.add_file 'rd_format.rd' - - refute rd.text? - end - -end diff --git a/test/rdoc/xref_data.rb b/test/rdoc/xref_data.rb deleted file mode 100644 index 257b821f4f..0000000000 --- a/test/rdoc/xref_data.rb +++ /dev/null @@ -1,163 +0,0 @@ -# frozen_string_literal: true -XREF_DATA = <<-XREF_DATA -class C1 - - attr :attr - - # :section: separate - - attr_reader :attr_reader - attr_writer :attr_writer - - # :section: - attr_accessor :attr_accessor - - CONST = :const - - def self.m - end - - def m foo - end - - def + - end -end - -class C2 - def b - end - - alias a b - - class C3 - def m - end - - class H1 - def m? - end - end - end -end - -class C3 - class H1 - end - - class H2 < H1 - end -end - -class C4 - class C4 - end -end - -class C5 - class C1 - end -end - -class C6 - private def priv1() end - def pub1() end - protected def prot1() end - def pub2() end - public def pub3() end - def pub4() end - - private - private def priv2() end - def priv3() end - protected def prot2() end - def priv4() end - public def pub5() end - def priv5() end - def self.s_pub1() end - class << self - def s_pub2() end - private - def s_priv1() end - end - - protected - private def priv6() end - def prot3() end - protected def prot4() end - def prot5() end - public def pub6() end - def prot6() end - def self.s_pub3() end - class << self - def s_pub4() end - protected - def s_prot1() end - end -end - -class C7 - attr_reader :attr_reader - attr_reader :attr_reader_nodoc # :nodoc: - attr_writer :attr_writer - attr_writer :attr_writer_nodoc # :nodoc: - attr_accessor :attr_accessor - attr_accessor :attr_accessor_nodoc # :nodoc: - - CONST = :const - CONST_NODOC = :const_nodoc # :nodoc: -end - -class C8 - class << self - class S1 - end - end -end - -class C9 - class A - def foo() end - def self.bar() end - end - - class B < A - def self.foo() end - def bar() end - end -end - -class C10 - class C11 - end - - def C11 - end -end - -def C10 -end - -class C11 -end - -def C11 -end - -module M1 - def m - end -end - -module M1::M2 -end - -class Parent - def m() end - def self.m() end -end - -class Child < Parent -end - -XREF_DATA diff --git a/test/rdoc/xref_test_case.rb b/test/rdoc/xref_test_case.rb deleted file mode 100644 index 0f7395e516..0000000000 --- a/test/rdoc/xref_test_case.rb +++ /dev/null @@ -1,93 +0,0 @@ -# frozen_string_literal: true -ENV['RDOC_TEST'] = 'yes' - -require_relative 'helper' -require File.expand_path '../xref_data', __FILE__ - -class XrefTestCase < RDoc::TestCase - - def setup - super - - @options = RDoc::Options.new - @options.quiet = true - - @rdoc.options = @options - - @file_name = 'xref_data.rb' - @xref_data = @store.add_file @file_name - @top_level = @xref_data - - stats = RDoc::Stats.new @store, 0 - - parser = RDoc::Parser::Ruby.new @xref_data, @file_name, XREF_DATA, @options, - stats - - @example_md = @store.add_file 'EXAMPLE.md' - @example_md.parser = RDoc::Parser::Markdown - - @top_levels = [] - @top_levels.push parser.scan - @top_levels.push @example_md - - generator = Object.new - def generator.class_dir() nil end - def generator.file_dir() nil end - @rdoc.options = @options - @rdoc.generator = generator - - @c1 = @xref_data.find_module_named 'C1' - @c1__m = @c1.find_class_method_named 'm' # C1::m - @c1_m = @c1.find_instance_method_named 'm' # C1#m - @c1_plus = @c1.find_instance_method_named '+' - - @c2 = @xref_data.find_module_named 'C2' - @c2_a = @c2.method_list.last - @c2_b = @c2.method_list.first - - @c2_c3 = @xref_data.find_module_named 'C2::C3' - @c2_c3_m = @c2_c3.method_list.first # C2::C3#m - - @c2_c3_h1 = @xref_data.find_module_named 'C2::C3::H1' - @c2_c3_h1_meh = @c2_c3_h1.method_list.first # C2::C3::H1#m? - - @c3 = @xref_data.find_module_named 'C3' - @c4 = @xref_data.find_module_named 'C4' - @c4_c4 = @xref_data.find_module_named 'C4::C4' - @c5_c1 = @xref_data.find_module_named 'C5::C1' - @c3_h1 = @xref_data.find_module_named 'C3::H1' - @c3_h2 = @xref_data.find_module_named 'C3::H2' - @c6 = @xref_data.find_module_named 'C6' - @c7 = @xref_data.find_module_named 'C7' - @c8 = @xref_data.find_module_named 'C8' - @c8_s1 = @xref_data.find_module_named 'C8::S1' - - @c9 = @xref_data.find_module_named 'C9' - @c9_a = @xref_data.find_module_named 'C9::A' - @c9_a_i_foo = @c9_a.method_list.first - @c9_a_c_bar = @c9_a.method_list.last - @c9_b = @xref_data.find_module_named 'C9::B' - @c9_b_c_foo = @c9_b.method_list.first - @c9_b_i_bar = @c9_b.method_list.last - - @object = @xref_data.find_module_named 'Object' - @c10_class = @xref_data.find_module_named 'C10' - @c10_method = @object.find_method_named 'C10' - @c11_class = @xref_data.find_module_named 'C11' - @c10_c11_class = @c10_class.find_module_named 'C11' - @c10_c11_method = @c10_class.find_method_named 'C11' - @c11_method = @object.find_method_named 'C11' - - @m1 = @xref_data.find_module_named 'M1' - @m1_m = @m1.method_list.first - - @m1_m2 = @xref_data.find_module_named 'M1::M2' - - @parent = @xref_data.find_module_named 'Parent' - @child = @xref_data.find_module_named 'Child' - - @parent_m = @parent.method_list.first # Parent#m - @parent__m = @parent.method_list.last # Parent::m - end - -end