Contents

# frozen_string_literal: true

require "sdoc"

class RDoc::Generator::API < RDoc::Generator::SDoc # :nodoc:
  RDoc::RDoc.add_generator self

  def generate_class_tree_level(classes, visited = {})
    # Only process core extensions on the first visit and remove
    # Active Storage duplicated classes that are at the top level
    # since they aren't nested under a definition of the `ActiveStorage` module.
    if visited.empty?
      classes = classes.reject { |klass| active_storage?(klass) }
      core_exts, classes = classes.partition { |klass| core_extension?(klass) }

      super.unshift([ "Core extensions", "", "", build_core_ext_subtree(core_exts, visited) ])
    else
      super
    end
  end

  private
    def build_core_ext_subtree(classes, visited)
      classes.map do |klass|
        [ klass.name, klass.document_self_or_methods ? klass.path : "", "",
            generate_class_tree_level(klass.classes_and_modules, visited) ]
      end
    end

    def core_extension?(klass)
      klass.name != "ActiveSupport" && klass.in_files.any? { |file| file.absolute_name.include?("core_ext") }
    end

    def active_storage?(klass)
      klass.name != "ActiveStorage" && klass.in_files.all? { |file| file.absolute_name.include?("active_storage") }
    end
end

Version data entries

43 entries across 43 versions & 4 rubygems

Version	Path
railties-5.2.8.1	lib/rails/api/generator.rb
railties-5.2.8	lib/rails/api/generator.rb
railties-5.2.7.1	lib/rails/api/generator.rb
railties-5.2.7	lib/rails/api/generator.rb
railties-5.2.6.3	lib/rails/api/generator.rb
railties-5.2.6.2	lib/rails/api/generator.rb
railties-5.2.6.1	lib/rails/api/generator.rb
railties-5.2.6	lib/rails/api/generator.rb
railties-5.2.4.6	lib/rails/api/generator.rb
railties-5.2.5	lib/rails/api/generator.rb
railties-5.2.4.5	lib/rails/api/generator.rb
railties-5.2.4.4	lib/rails/api/generator.rb
railties-5.2.4.3	lib/rails/api/generator.rb
railties-5.2.4.2	lib/rails/api/generator.rb
railties-5.2.4.1	lib/rails/api/generator.rb
zuora_connect_ui-0.10.0	vendor/ruby/2.6.0/gems/railties-5.2.3/lib/rails/api/generator.rb
railties-5.2.4	lib/rails/api/generator.rb
railties-5.2.4.rc1	lib/rails/api/generator.rb
zuora_connect_ui-0.9.2	vendor/ruby/2.6.0/gems/railties-5.2.3/lib/rails/api/generator.rb
zuora_connect_ui-0.9.1	vendor/ruby/2.6.0/gems/railties-5.2.3/lib/rails/api/generator.rb