rdoc 8.0.0 → 8.1.0

data/lib/rdoc/generator/pot/po_entry.rb

@@ -1,141 +1,147 @@
 # 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
+module RDoc
+  module Generator
+    class POT
+      ##
+      # A PO entry in PO
+
+      class 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
+        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
 
-  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

data/lib/rdoc/generator/pot.rb

@@ -1,94 +1,98 @@
 # 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.
+module RDoc
+  module Generator
+    ##
+    # 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
+    class POT
 
-  RDoc::RDoc.add_generator self
+      RDoc.add_generator self
 
-  ##
-  # Description of this generator
+      ##
+      # Description of this generator
 
-  DESCRIPTION = 'creates .pot file'
+      DESCRIPTION = 'creates .pot file'
 
-  ##
-  # Set up a new .pot generator
+      ##
+      # Set up a new .pot generator
 
-  def initialize(store, options) #:not-new:
-    @options    = options
-    @store      = store
-  end
+      def initialize(store, options) #:not-new:
+        @options    = options
+        @store      = store
+      end
 
-  ##
-  # Writes .pot to disk.
+      ##
+      # 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
+      def generate
+        po = extract_messages
+        pot_path = 'rdoc.pot'
+        File.open(pot_path, "w") do |pot|
+          pot.print(po.to_s)
+        end
+      end
 
-  private
-  def extract_messages
-    extractor = MessageExtractor.new(@store)
-    extractor.extract
-  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'
+      require_relative 'pot/message_extractor'
+      require_relative 'pot/po'
+      require_relative 'pot/po_entry'
 
+    end
+  end
 end

data/lib/rdoc/generator/ri.rb

@@ -1,30 +1,34 @@
 # frozen_string_literal: true
-##
-# Generates ri data files
+module RDoc
+  module Generator
+    ##
+    # Generates ri data files
 
-class RDoc::Generator::RI
+    class RI
 
-  RDoc::RDoc.add_generator self
+      RDoc.add_generator self
 
-  ##
-  # Description of this generator
+      ##
+      # Description of this generator
 
-  DESCRIPTION = 'creates ri data files'
+      DESCRIPTION = 'creates ri data files'
 
-  ##
-  # Set up a new ri generator
+      ##
+      # Set up a new ri generator
 
-  def initialize(store, options) #:not-new:
-    @options    = options
-    @store      = store
-    @store.path = '.'
-  end
+      def initialize(store, options) #:not-new:
+        @options    = options
+        @store      = store
+        @store.path = '.'
+      end
 
-  ##
-  # Writes the parsed data store to disk for use by ri.
+      ##
+      # Writes the parsed data store to disk for use by ri.
 
-  def generate
-    @store.save
-  end
+      def generate
+        @store.save
+      end
 
+    end
+  end
 end

data/lib/rdoc/generator/template/aliki/DESIGN.md

@@ -289,12 +289,14 @@ horizontally.
 
 ### Search
 
+One search form and one result list serve both header layouts. CSS changes the presentation at `1023px`.
+
 | Element                          | Value                                                       |
 |----------------------------------|-------------------------------------------------------------|
-| Desktop field (`#search-field`)  | full-width border-box, `space-2 space-4` pad, 1px border, `radius-md`, `base`; focus → accent border + `0 0 0 3px accent-subtle` |
-| Desktop dropdown (`#search-results-desktop`) | absolute inside the search form, full-width border-box to match the field, `max-height: 60vh`, `radius-lg`, `shadow-lg`, `z-popover` (500) |
-| Mobile modal (`.search-modal-content`) | centered card, `max-width: 600px`, `max-height: 80vh`, `radius-lg`, `shadow-xl` |
-| Modal result item                | `space-3 space-4` pad, `radius-md`, hover `background-secondary` |
+| Shared field (`#search-field`)   | full-width border-box, `space-2 space-4` pad, 1px border, `radius-md`, `base`. Focus uses an accent border + `0 0 0 3px accent-subtle` |
+| Desktop results (`#search-results`) | absolute inside the search surface, full-width border-box, `max-height: 60vh`, `radius-lg`, `shadow-lg`, `z-popover` (500) |
+| Compact surface (`.navbar-search.is-open .search-surface`) | centered overlay, `max-width: 600px`, `max-height: 80vh`, `radius-lg`, `shadow-xl` |
+| Compact result item              | `space-3 space-4` pad, `radius-md`, hover `background-secondary` |
 | Servlet field                    | pill `border-radius: 1.25rem`, leading 🔍 (`\1F50D`) glyph   |
 | Result lines                     | `.search-match` `base` · `.search-namespace` `sm` secondary · `.search-snippet` `sm` tertiary |
 | Type badge (`.search-type-*`)    | inline-block, `space-0 space-2` pad, `xs`, weight 500, `radius-sm`, colors per §2 |

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

@@ -16,7 +16,7 @@
 
   <div class="footer-bottom">
     <p>
-      Generated by <a href="https://ruby.github.io/rdoc/">RDoc <%= RDoc::VERSION %></a>
+      Generated by <a href="https://ruby.github.io/rdoc/">RDoc <%= VERSION %></a>
       using the Aliki theme by <a href="http://st0012.dev">Stan Lo</a>
     </p>
   </div>

data/lib/rdoc/generator/template/aliki/_head.rhtml

@@ -112,52 +112,52 @@
 </script>
 
 <script
-  src="<%= h asset_rel_prefix %>/js/theme-toggle.js?v=<%= h RDoc::VERSION %>"
+  src="<%= h asset_rel_prefix %>/js/theme-toggle.js?v=<%= h VERSION %>"
 ></script>
 
 <script
-  src="<%= h asset_rel_prefix %>/js/search_navigation.js?v=<%= h RDoc::VERSION %>"
+  src="<%= h asset_rel_prefix %>/js/search_navigation.js?v=<%= h VERSION %>"
   defer
 ></script>
 
 <script
-  src="<%= h asset_rel_prefix %>/js/search_data.js?v=<%= h RDoc::VERSION %>"
+  src="<%= h asset_rel_prefix %>/js/search_data.js?v=<%= h VERSION %>"
   defer
 ></script>
 
 <script
-  src="<%= h asset_rel_prefix %>/js/search_ranker.js?v=<%= h RDoc::VERSION %>"
+  src="<%= h asset_rel_prefix %>/js/search_ranker.js?v=<%= h VERSION %>"
   defer
 ></script>
 
 <script
-  src="<%= h asset_rel_prefix %>/js/search_controller.js?v=<%= h RDoc::VERSION %>"
+  src="<%= h asset_rel_prefix %>/js/search_controller.js?v=<%= h VERSION %>"
   defer
 ></script>
 
 <script
-  src="<%= h asset_rel_prefix %>/js/c_highlighter.js?v=<%= h RDoc::VERSION %>"
+  src="<%= h asset_rel_prefix %>/js/c_highlighter.js?v=<%= h VERSION %>"
   defer
 ></script>
 
 <script
-  src="<%= h asset_rel_prefix %>/js/bash_highlighter.js?v=<%= h RDoc::VERSION %>"
+  src="<%= h asset_rel_prefix %>/js/bash_highlighter.js?v=<%= h VERSION %>"
   defer
 ></script>
 
 <script
-  src="<%= h asset_rel_prefix %>/js/aliki.js?v=<%= h RDoc::VERSION %>"
+  src="<%= h asset_rel_prefix %>/js/aliki.js?v=<%= h VERSION %>"
   defer
 ></script>
 
 <link
-  href="<%= h asset_rel_prefix %>/css/rdoc.css?v=<%= h RDoc::VERSION %>"
+  href="<%= h asset_rel_prefix %>/css/rdoc.css?v=<%= h VERSION %>"
   rel="stylesheet"
 >
 
 <%- @options.template_stylesheets.each do |stylesheet| %>
   <link
-    href="<%= h asset_rel_prefix %>/<%= h File.basename stylesheet %>?v=<%= h RDoc::VERSION %>"
+    href="<%= h asset_rel_prefix %>/<%= h File.basename stylesheet %>?v=<%= h VERSION %>"
     rel="stylesheet"
   >
 <%- end %>