rdoc 3.1 → 6.3.3

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

@@ -0,0 +1,141 @@
+# 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 valus 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

data/lib/rdoc/generator/pot.rb

@@ -0,0 +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.
+
+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
+
+  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

data/lib/rdoc/generator/ri.rb

@@ -1,6 +1,4 @@
-require 'rdoc/generator'
-require 'rdoc/ri'
-
+# frozen_string_literal: true
 ##
 # Generates ri data files
 
@@ -16,69 +14,17 @@ class RDoc::Generator::RI
   ##
   # Set up a new ri generator
 
-  def initialize options #:not-new:
-    @options     = options
-    @store       = RDoc::RI::Store.new '.'
-    @old_siginfo = nil
-    @current     = nil
-
-    @store.dry_run = @options.dry_run
-  end
-
-  ##
-  # Build the initial indices and output objects based on an array of TopLevel
-  # objects containing the extracted information.
-
-  def generate top_levels
-    install_siginfo_handler
-
-    @store.load_cache
-
-    RDoc::TopLevel.all_classes_and_modules.each do |klass|
-      @current = "#{klass.class}: #{klass.full_name}"
-
-      @store.save_class klass
-
-      klass.each_method do |method|
-        @current = "#{method.class}: #{method.full_name}"
-        @store.save_method klass, method
-      end
-
-      klass.each_attribute do |attribute|
-        @store.save_method klass, attribute
-      end
-    end
-
-    @current = 'saving cache'
-
-    @store.save_cache
-
-  ensure
-    @current = nil
-
-    remove_siginfo_handler
+  def initialize store, options #:not-new:
+    @options    = options
+    @store      = store
+    @store.path = '.'
   end
 
   ##
-  # Installs a siginfo handler that prints the current filename.
-
-  def install_siginfo_handler
-    return unless Signal.list.key? 'INFO'
-
-    @old_siginfo = trap 'INFO' do
-      puts @current if @current
-    end
-  end
-
-  ##
-  # Removes a siginfo handler and replaces the previous
-
-  def remove_siginfo_handler
-    return unless Signal.list.key? 'INFO'
-
-    handler = @old_siginfo || 'DEFAULT'
+  # Writes the parsed data store to disk for use by ri.
 
-    trap 'INFO', handler
+  def generate
+    @store.save
   end
 
 end

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

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

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

@@ -0,0 +1,22 @@
+<meta charset="<%= @options.charset %>">
+
+<title><%= h @title %></title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "<%= asset_rel_prefix %>/";
+  var index_rel_prefix = "<%= rel_prefix %>/";
+</script>
+
+<script src="<%= asset_rel_prefix %>/js/navigation.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/search.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/search_index.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/searcher.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/darkfish.js" defer></script>
+
+<link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
+<link href="<%= asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
+<%- if @options.template_stylesheets.flatten.any? then -%>
+<%-   @options.template_stylesheets.flatten.each do |stylesheet| -%>
+<link href="<%= asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
+<%-   end -%>
+<%- end -%>

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

@@ -0,0 +1,19 @@
+<%- if !svninfo.empty? then %>
+<div id="file-svninfo-section" class="nav-section">
+  <h3>VCS Info</h3>
+
+  <div class="section-body">
+    <dl class="svninfo">
+      <dt>Rev
+      <dd><%= svninfo[:rev] %>
+
+      <dt>Last Checked In
+      <dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
+        (<%= svninfo[:commitdelta] %> ago)
+
+      <dt>Checked in by
+      <dd><%= svninfo[:committer] %>
+    </dl>
+  </div>
+</div>
+<%- end -%>

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

@@ -0,0 +1,9 @@
+<div id="classindex-section" class="nav-section">
+  <h3>Class and Module Index</h3>
+
+  <ul class="link-list">
+  <%- @modsort.each do |index_klass| -%>
+    <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
+  <%- end -%>
+  </ul>
+</div>

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

@@ -0,0 +1,15 @@
+<%- unless klass.extends.empty? then %>
+<div id="extends-section" class="nav-section">
+  <h3>Extended With Modules</h3>
+
+  <ul class="link-list">
+    <%- klass.each_extend do |ext| -%>
+  <%- unless String === ext.module then -%>
+    <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
+  <%- else -%>
+    <li><span class="extend"><%= ext.name %></span>
+  <%- end -%>
+  <%- end -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,9 @@
+<div id="file-list-section" class="nav-section">
+  <h3>Defined In</h3>
+
+  <ul>
+<%- klass.in_files.each do |tl| -%>
+    <li><%= h tl.relative_name %>
+<%- end -%>
+  </ul>
+</div>

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

@@ -0,0 +1,15 @@
+<%- unless klass.includes.empty? then %>
+<div id="includes-section" class="nav-section">
+  <h3>Included Modules</h3>
+
+  <ul class="link-list">
+  <%- klass.each_include do |inc| -%>
+  <%- unless String === inc.module then -%>
+    <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
+  <%- else -%>
+    <li><span class="include"><%= inc.name %></span>
+  <%- end -%>
+  <%- end -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,15 @@
+<div id="home-section" class="nav-section">
+  <h3>Documentation</h3>
+
+  <ul>
+  <%- installed.each do |name, href, exists, type, _| -%>
+    <%- next if type == :extra -%>
+    <li class="folder">
+    <%- if exists then -%>
+      <a href="<%= href %>"><%= h name %></a>
+    <%- else -%>
+      <%= h name %>
+    <%- end -%>
+  <%- end -%>
+  </ul>
+</div>

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

@@ -0,0 +1,12 @@
+<%- unless klass.method_list.empty? then %>
+<!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    <%- klass.each_method do |meth| -%>
+    <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name -%></a>
+    <%- end -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,11 @@
+<div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="<%= rel_prefix %>/index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="<%= rel_prefix %>/table_of_contents.html#pages">Pages</a>
+    <a href="<%= rel_prefix %>/table_of_contents.html#classes">Classes</a>
+    <a href="<%= rel_prefix %>/table_of_contents.html#methods">Methods</a>
+  </div>
+</div>

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

@@ -0,0 +1,12 @@
+<%- simple_files = @files.select { |f| f.text? } %>
+<%- unless simple_files.empty? then -%>
+<div id="fileindex-section" class="nav-section">
+  <h3>Pages</h3>
+
+  <ul class="link-list">
+  <%- simple_files.each do |f| -%>
+    <li><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
+  <%- end -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,11 @@
+<%- if klass.type == 'class' then %>
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <%- if klass.superclass and not String === klass.superclass then -%>
+  <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
+  <%- else -%>
+  <p class="link"><%= klass.superclass %>
+  <%- end -%>
+</div>
+<%- end -%>

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

@@ -0,0 +1,14 @@
+<div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>

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

@@ -0,0 +1,11 @@
+<%- unless klass.sections.length == 1 then %>
+<div id="sections-section" class="nav-section">
+  <h3>Sections</h3>
+
+  <ul class="link-list" role="directory">
+    <%- klass.sort_sections.each do |section| -%>
+      <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+    <%- end -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,18 @@
+<%- comment = if current.respond_to? :comment_location then
+               current.comment_location
+             else
+               current.comment
+             end
+   table = current.parse(comment).table_of_contents
+
+   if table.length > 1 then %>
+<div class="nav-section">
+  <h3>Table of Contents</h3>
+
+  <ul class="link-list" role="directory">
+<%-   table.each do |heading| -%>
+    <li><a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
+<%-   end -%>
+  </ul>
+</div>
+<%- end -%>