rdoc 8.0.0 → 8.1.0

data/lib/rdoc/generator/template/aliki/js/aliki.js

@@ -47,6 +47,8 @@ function createSearchInstance(input, result) {
       html += `<span class="search-type search-type-${this.escapeHTML(typeClass)}">${typeLabel}</span>`;
     }
 
+    html += '</p>';
+
     if (result.snippet)
       html += `<div class="search-snippet">${result.snippet}</div>`;
 
@@ -75,10 +77,15 @@ function createSearchInstance(input, result) {
 
 function hookSearch() {
   const input  = document.querySelector('#search-field');
-  const result = document.querySelector('#search-results-desktop');
+  const result = document.querySelector('#search-results');
 
   if (!input || !result) return; // Exit if search elements not found
 
+  const container = input.closest('[data-search-container]');
+  const searchToggle = document.querySelector('#search-toggle');
+  const searchEmpty = container && container.querySelector('.search-empty');
+  let focusBeforeOpen = null;
+
   const search_section = document.querySelector('#search-section');
   if (search_section) {
     search_section.classList.remove("initially-hidden");
@@ -87,23 +94,65 @@ function hookSearch() {
   const search = createSearchInstance(input, result);
   if (!search) return;
 
+  if (searchEmpty) {
+    const originalRenderItem = search.renderItem;
+    search.renderItem = function(result) {
+      searchEmpty.style.display = 'none';
+      return originalRenderItem.call(this, result);
+    };
+  }
+
+  const showSearchSurface = () => {
+    if (container) container.classList.add('is-open');
+    if (searchToggle) searchToggle.setAttribute('aria-expanded', 'true');
+  };
+
+  const openSearch = () => {
+    focusBeforeOpen = document.activeElement;
+    showSearchSurface();
+    input.focus({ preventScroll: true });
+  };
+
+  const closeSearch = (restoreFocus = true) => {
+    if (container) container.classList.remove('is-open');
+    if (searchToggle) searchToggle.setAttribute('aria-expanded', 'false');
+    search.hide();
+    input.blur();
+
+    if (restoreFocus && focusBeforeOpen && typeof focusBeforeOpen.focus === 'function') {
+      focusBeforeOpen.focus({ preventScroll: true });
+    }
+    focusBeforeOpen = null;
+  };
+
+  if (searchToggle) searchToggle.addEventListener('click', openSearch);
+  if (container) {
+    container.querySelectorAll('[data-search-close]').forEach((control) => {
+      control.addEventListener('click', () => closeSearch());
+    });
+  }
+
+  hookFocus(openSearch);
+
   // Hide search results when clicking outside the search area
   document.addEventListener('click', (e) => {
-    if (!e.target.closest('.navbar-search-desktop')) {
-      search.hide();
-    }
+    if (container && container.contains(e.target)) return;
+
+    search.hide();
+    if (container && container.classList.contains('is-open')) closeSearch(false);
   });
 
-  // Hide search results on Escape key on desktop too
+  // Close the search surface on Escape
   document.addEventListener('keydown', (e) => {
-    if (e.key === 'Escape' && input.matches(":focus")) {
-      search.hide();
-      input.blur();
+    const isOpen = container && container.classList.contains('is-open');
+    if (e.key === 'Escape' && (isOpen || input.matches(":focus"))) {
+      closeSearch();
     }
   });
 
   // Show search results when focusing on input (if there's a query)
   input.addEventListener('focus', () => {
+    showSearchSurface();
     if (input.value.trim()) {
       search.show();
     }
@@ -114,6 +163,7 @@ function hookSearch() {
     const urlParams = new URLSearchParams(window.location.search);
     const queryParam = urlParams.get('q');
     if (queryParam) {
+      openSearch();
       input.value = queryParam;
       search.search(queryParam, false);
     }
@@ -122,14 +172,14 @@ function hookSearch() {
 
 /* ===== Keyboard Shortcuts ===== */
 
-function hookFocus() {
+function hookFocus(openSearch) {
   document.addEventListener("keydown", (event) => {
     if (document.activeElement.tagName === 'INPUT') {
       return;
     }
     if (event.key === "/") {
       event.preventDefault();
-      document.querySelector('#search-field').focus();
+      openSearch();
     }
   });
 }
@@ -328,78 +378,6 @@ function setHeadingSelfLinkScrollHandlers() {
   })
 }
 
-/* ===== Mobile Search Modal ===== */
-
-function hookSearchModal() {
-  const searchToggle = document.querySelector('#search-toggle');
-  const searchModal = document.querySelector('#search-modal');
-  const searchModalClose = document.querySelector('#search-modal-close');
-  const searchModalBackdrop = document.querySelector('.search-modal-backdrop');
-  const searchInput = document.querySelector('#search-field-mobile');
-  const searchResults = document.querySelector('#search-results-mobile');
-  const searchEmpty = document.querySelector('.search-modal-empty');
-
-  if (!searchToggle || !searchModal) return;
-
-  // Initialize search for mobile modal
-  const mobileSearch = createSearchInstance(searchInput, searchResults);
-  if (!mobileSearch) return;
-
-  // Hide empty state when there are results
-  const originalRenderItem = mobileSearch.renderItem;
-  mobileSearch.renderItem = function(result) {
-    if (searchEmpty) searchEmpty.style.display = 'none';
-    return originalRenderItem.call(this, result);
-  };
-
-  const openSearchModal = () => {
-    searchModal.hidden = false;
-    document.body.style.overflow = 'hidden';
-    // Focus input after animation
-    setTimeout(() => {
-      if (searchInput) searchInput.focus();
-    }, 100);
-  };
-
-  const closeSearchModal = () => {
-    searchModal.hidden = true;
-    document.body.style.overflow = '';
-  };
-
-  // Open on button click
-  searchToggle.addEventListener('click', openSearchModal);
-
-  // Close on close button click
-  if (searchModalClose) {
-    searchModalClose.addEventListener('click', closeSearchModal);
-  }
-
-  // Close on backdrop click
-  if (searchModalBackdrop) {
-    searchModalBackdrop.addEventListener('click', closeSearchModal);
-  }
-
-  // Close on Escape key
-  document.addEventListener('keydown', (e) => {
-    if (e.key === 'Escape' && !searchModal.hidden) {
-      closeSearchModal();
-    }
-  });
-
-  // Check for ?q= URL parameter on mobile and open modal
-  if (typeof URLSearchParams !== 'undefined') {
-    const urlParams = new URLSearchParams(window.location.search);
-    const queryParam = urlParams.get('q');
-    const isSmallViewport = window.matchMedia("(max-width: 1023px)").matches;
-
-    if (queryParam && isSmallViewport) {
-      openSearchModal();
-      searchInput.value = queryParam;
-      mobileSearch.search(queryParam, false);
-    }
-  }
-}
-
 /* ===== Code Block Copy Functionality ===== */
 
 function createCopyButton() {
@@ -503,11 +481,9 @@ function showCopySuccess(button) {
 document.addEventListener('DOMContentLoaded', () => {
   hookSourceViews();
   hookSearch();
-  hookFocus();
   hookSidebar();
   generateToc();
   setHeadingSelfLinkScrollHandlers();
   hookTocActiveHighlighting();
-  hookSearchModal();
   wrapCodeBlocksWithCopyButton();
 });

data/lib/rdoc/generator/template/darkfish/_footer.rhtml

@@ -1,5 +1,5 @@
 <footer id="validator-badges" role="contentinfo">
   <p><a href="https://validator.w3.org/check/referer">Validate</a></p>
-  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= RDoc::VERSION %>.</p>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= VERSION %>.</p>
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>
 </footer>

data/lib/rdoc/generator.rb

@@ -1,52 +1,54 @@
 # 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
+  ##
+  # 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
+  module Generator
 
-  autoload :Markup,   "#{__dir__}/generator/markup"
+    autoload :Markup,   "#{__dir__}/generator/markup"
 
-  autoload :Aliki,     "#{__dir__}/generator/aliki"
-  autoload :Darkfish,  "#{__dir__}/generator/darkfish"
-  autoload :JsonIndex, "#{__dir__}/generator/json_index"
-  autoload :RI,        "#{__dir__}/generator/ri"
-  autoload :POT,       "#{__dir__}/generator/pot"
+    autoload :Aliki,     "#{__dir__}/generator/aliki"
+    autoload :Darkfish,  "#{__dir__}/generator/darkfish"
+    autoload :JsonIndex, "#{__dir__}/generator/json_index"
+    autoload :RI,        "#{__dir__}/generator/ri"
+    autoload :POT,       "#{__dir__}/generator/pot"
 
+  end
 end

data/lib/rdoc/i18n/locale.rb

@@ -1,102 +1,106 @@
 # frozen_string_literal: true
-##
-# A message container for a locale.
-#
-# This object provides the following two features:
-#
-#   * Loads translated messages from .po file.
-#   * Translates a message into the locale.
-
-class RDoc::I18n::Locale
-
-  @@locales = {} # :nodoc:
-
-  class << self
-
+module RDoc
+  module I18n
     ##
-    # Returns the locale object for +locale_name+.
-
-    def [](locale_name)
-      @@locales[locale_name] ||= new(locale_name)
-    end
-
-    ##
-    # Sets the locale object for +locale_name+.
+    # A message container for a locale.
     #
-    # Normally, this method is not used. This method is useful for
-    # testing.
-
-    def []=(locale_name, locale)
-      @@locales[locale_name] = locale
-    end
-
-  end
-
-  ##
-  # The name of the locale. It uses IETF language tag format
-  # +[language[_territory][.codeset][@modifier]]+.
-  #
-  # See also {BCP 47 - Tags for Identifying
-  # Languages}[http://tools.ietf.org/rfc/bcp/bcp47.txt].
-
-  attr_reader :name
-
-  ##
-  # Creates a new locale object for +name+ locale. +name+ must
-  # follow IETF language tag format.
-
-  def initialize(name)
-    @name = name
-    @messages = {}
-  end
+    # This object provides the following two features:
+    #
+    #   * Loads translated messages from .po file.
+    #   * Translates a message into the locale.
+
+    class Locale
+
+      @@locales = {} # :nodoc:
+
+      class << self
+
+        ##
+        # Returns the locale object for +locale_name+.
+
+        def [](locale_name)
+          @@locales[locale_name] ||= new(locale_name)
+        end
+
+        ##
+        # Sets the locale object for +locale_name+.
+        #
+        # Normally, this method is not used. This method is useful for
+        # testing.
+
+        def []=(locale_name, locale)
+          @@locales[locale_name] = locale
+        end
+
+      end
+
+      ##
+      # The name of the locale. It uses IETF language tag format
+      # +[language[_territory][.codeset][@modifier]]+.
+      #
+      # See also {BCP 47 - Tags for Identifying
+      # Languages}[http://tools.ietf.org/rfc/bcp/bcp47.txt].
+
+      attr_reader :name
+
+      ##
+      # Creates a new locale object for +name+ locale. +name+ must
+      # follow IETF language tag format.
+
+      def initialize(name)
+        @name = name
+        @messages = {}
+      end
+
+      ##
+      # Loads translation messages from +locale_directory+/+@name+/rdoc.po
+      # or +locale_directory+/+@name+.po. The former has high priority.
+      #
+      # This method requires gettext gem for parsing .po file. If you
+      # don't have gettext gem, this method doesn't load .po file. This
+      # method warns and returns +false+.
+      #
+      # Returns +true+ if succeeded, +false+ otherwise.
+
+      def load(locale_directory)
+        return false if @name.nil?
+
+        po_file_candidates = [
+          File.join(locale_directory, @name, 'rdoc.po'),
+          File.join(locale_directory, "#{@name}.po"),
+        ]
+        po_file = po_file_candidates.find do |po_file_candidate|
+          File.exist?(po_file_candidate)
+        end
+        return false unless po_file
+
+        begin
+          require 'gettext/po_parser'
+          require 'gettext/mo'
+        rescue LoadError
+          warn('Need gettext gem for i18n feature:')
+          warn('  gem install gettext')
+          return false
+        end
+
+        po_parser = GetText::POParser.new
+        messages = GetText::MO.new
+        po_parser.report_warning = false
+        po_parser.parse_file(po_file, messages)
+
+        @messages.merge!(messages)
+
+        true
+      end
+
+      ##
+      # Translates the +message+ into locale. If there is no translation
+      # messages for +message+ in locale, +message+ itself is returned.
+
+      def translate(message)
+        @messages[message] || message
+      end
 
-  ##
-  # Loads translation messages from +locale_directory+/+@name+/rdoc.po
-  # or +locale_directory+/+@name+.po. The former has high priority.
-  #
-  # This method requires gettext gem for parsing .po file. If you
-  # don't have gettext gem, this method doesn't load .po file. This
-  # method warns and returns +false+.
-  #
-  # Returns +true+ if succeeded, +false+ otherwise.
-
-  def load(locale_directory)
-    return false if @name.nil?
-
-    po_file_candidates = [
-      File.join(locale_directory, @name, 'rdoc.po'),
-      File.join(locale_directory, "#{@name}.po"),
-    ]
-    po_file = po_file_candidates.find do |po_file_candidate|
-      File.exist?(po_file_candidate)
-    end
-    return false unless po_file
-
-    begin
-      require 'gettext/po_parser'
-      require 'gettext/mo'
-    rescue LoadError
-      warn('Need gettext gem for i18n feature:')
-      warn('  gem install gettext')
-      return false
     end
-
-    po_parser = GetText::POParser.new
-    messages = GetText::MO.new
-    po_parser.report_warning = false
-    po_parser.parse_file(po_file, messages)
-
-    @messages.merge!(messages)
-
-    true
-  end
-
-  ##
-  # Translates the +message+ into locale. If there is no translation
-  # messages for +message+ in locale, +message+ itself is returned.
-
-  def translate(message)
-    @messages[message] || message
   end
-
 end