rdtool 0.6.37 → 0.6.39

data/lib/rd/rdvisitor.rb

@@ -193,7 +193,7 @@ this module provide several functions for MehotList.
       indexes = []
       tree.each do |i|
 	if i.is_a?(MethodListItem)
-	  klass, kind, method, args = analize_method(i.term.content)
+	  klass, kind, method, _args = analize_method(i.term.content)
 	  indexes.push([klass, kind2num(kind), method, kind]) if kind
 	end
       end
@@ -211,4 +211,3 @@ end # RD
  $Id: rdvisitor.rb,v 1.46 2003/02/18 16:20:25 tosh Exp $
 
 =end
-

data/lib/rd/version.rb

@@ -1,14 +1,14 @@
 module RD
 
-  VERSION = '0.6.37'
+  VERSION = '0.6.39'
 
   class Version
     attr_reader :name
     attr_reader :major, :minor, :patch_level
 
-    def Version.new_from_version_string(name, version_str)
-      major, minor, patch_level, *dummy = analyze_version_string(version_str)
-      return Version.new(name, major, minor, patch_level)
+    def self.new_from_version_string(name, version_str)
+      major, minor, patch_level, = analyze_version_string(version_str)
+      Version.new(name, major, minor, patch_level)
     end
     
     def initialize(name, major, minor, patch_level)
@@ -18,7 +18,7 @@ module RD
       @patch_level = patch_level
     end
 
-    def Version.analyze_version_string(version_str)
+    def self.analyze_version_string(version_str)
       version_str = clean_up_version_string(version_str)
       version_str.split(/\./).collect{|i| i.to_i }
     end
@@ -30,7 +30,7 @@ module RD
       result
     end
 
-    def Version.clean_up_version_string(version_str)
+    def self.clean_up_version_string(version_str)
       if /^\$Version:?\s*(.*)\$/ === version_str
 	$1
       else

data/rdtool.gemspec

@@ -1,24 +1,28 @@
 # -*- coding: utf-8; mode: ruby -*-
 Gem::Specification.new do |s|
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.rubygems_version = "1.3.5"
-
   s.name = 'rdtool'
-  s.version = '0.6.37'
-  s.date = '2012-06-12'
+  s.version = '0.6.39'
+  s.date = '2026-03-17'
 
-  s.summary = "RDtool is formatter for RD."
-  s.description = "RD is multipurpose documentation format created for documentating Ruby and output of Ruby world. You can embed RD into Ruby script. And RD have neat syntax which help you to read document in Ruby script. On the other hand, RD have a feature for class reference."
+  s.summary = "Formatter and converter for RD documents."
+  s.description = "RDtool parses RD documents and converts them to formats such as HTML and roff. It also includes utilities for working with RD embedded in Ruby source files."
   s.authors = ["Youhei SASAKI"]
   s.email = "uwabami@gfd-dennou.org"
-  s.homepage = "http://github.com/uwabami/rdtool"
-  s.licenses = ["GPL-2+", "Ruby"]
+  s.homepage = "https://github.com/uwabami/rdtool"
+  s.licenses = ["GPL-2.0-or-later", "Ruby"]
+  s.required_ruby_version = ">= 3.2"
   s.require_paths = ["lib"]
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.executables = %w[rd2 rdswap.rb]
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/uwabami/rdtool/issues",
+    "changelog_uri" => "https://github.com/uwabami/rdtool/blob/main/HISTORY",
+    "source_code_uri" => "https://github.com/uwabami/rdtool",
+  }
 
-  s.add_development_dependency('racc', "~> 1.4.6")
-  s.add_development_dependency('rake', ">= 0") unless defined? Rake
+  s.add_dependency('nkf', '>= 0.1', '< 1.0')
+  s.add_development_dependency('racc', "~> 1.4")
+  s.add_development_dependency('test-unit', "~> 3.0")
+  s.add_development_dependency('rake', "~> 13.0")
 
   # = MANIFEST =
   s.files = %w[
@@ -64,7 +68,9 @@ Gem::Specification.new do |s|
     lib/rd/rd2html-ext-opt.rb
     lib/rd/rd2html-lib.rb
     lib/rd/rd2html-opt.rb
+    lib/rd/rd2html5-lib.rb
     lib/rd/rd2man-lib.rb
+    lib/rd/rd2man-opt.rb
     lib/rd/rd2rdo-lib.rb
     lib/rd/rd2rmi-lib.rb
     lib/rd/rdblockparser.ry
@@ -107,7 +113,11 @@ Gem::Specification.new do |s|
     test/test-parser-util.rb
     test/test-rbl-file.rb
     test/test-rbl-suite.rb
+    test/test-rd2-cli.rb
     test/test-rd2html-lib.rb
+    test/test-rd2html5-lib.rb
+    test/test-rd2man-lib.rb
+    test/test-rdswap-cli.rb
     test/test-rdtree.rb
     test/test-rdvisitor.rb
     test/test-reference-resolver.rb

data/test/test-methodlist-item.rb

@@ -34,7 +34,6 @@ class TestMethodListItem < Test::Unit::TestCase
   def test_inspect
     mi = MethodListItem.new
     mt = MethodListItem::Term.new
-    se = StringElement.new "string"
     tb = TextBlock.new
     mi.set_term_under_document_struct(mt, DocumentStructure::RD)
     mi.add_child_under_document_struct(tb, DocumentStructure::RD)

data/test/test-rbl-file.rb

@@ -16,14 +16,12 @@ class TestRBLFile < Test::Unit::TestCase
     tr_head2 = Tree.new_with_document_struct(DocumentStructure::RD)
     de_head2 = DocumentElement.new
     tr_head2.root = de_head2
-    hl1_head2, hl2_head2 = nil
-
     de_head2.build do
-      hl1_head2 = new Headline, 1 do
+      new Headline, 1 do
         new StringElement, "label1"
       end
       new TextBlock
-      hl2_head2 = new Headline, 2 do
+      new Headline, 2 do
         new StringElement, "label2"
       end
     end
@@ -33,14 +31,13 @@ class TestRBLFile < Test::Unit::TestCase
     tr_desc = Tree.new_with_document_struct(DocumentStructure::RD)
     de_desc = DocumentElement.new
     tr_desc.root = de_desc
-    hl1_desc, dt1_desc = nil
     de_desc.build do
-      hl1_desc = new(Headline, 1) do
+      new(Headline, 1) do
         new StringElement, "label1"
       end
       new DescList do
         new DescListItem do
-          dt1_desc = make_term do
+          make_term do
             new StringElement, "label2"
           end
         end

data/test/test-rd2-cli.rb

@@ -0,0 +1,91 @@
+require "test/unit"
+require "open3"
+require "rbconfig"
+require "tmpdir"
+require "fileutils"
+
+class TestRD2CLI < Test::Unit::TestCase
+  def setup
+    @root = File.expand_path("..", __dir__)
+    @rd2 = File.join(@root, "bin", "rd2")
+    @libdir = File.join(@root, "lib")
+  end
+
+  def test_external_sub_option_parser_registered_via_argv_options_is_shown_in_help
+    Dir.mktmpdir("rd2-cli") do |tmpdir|
+      write_fake_formatter_files(tmpdir)
+
+      _stdout, stderr, status = run_rd2(tmpdir, "-r", "fake_rd2_visitor", "--help")
+
+      assert_predicate(status, :success?, stderr)
+      assert_match(/--fake-flag/, stderr)
+    end
+  end
+
+  def test_external_sub_option_parser_registered_via_argv_options_is_applied
+    Dir.mktmpdir("rd2-cli") do |tmpdir|
+      write_fake_formatter_files(tmpdir)
+      input = File.join(tmpdir, "sample.rd")
+      File.write(input, "=begin\n= sample\n=end\n")
+
+      stdout, stderr, status = run_rd2(tmpdir, "-r", "fake_rd2_visitor", "--fake-flag", input)
+
+      assert_predicate(status, :success?, stderr)
+      assert_equal("flag-on\n", stdout)
+    end
+  end
+
+  def test_rd2man_supports_custom_man_section
+    Dir.mktmpdir("rd2-cli") do |tmpdir|
+      input = File.join(tmpdir, "sample.rd")
+      File.write(input, "=begin\n= sample\n=end\n")
+
+      stdout, stderr, status = run_rd2(nil, "-r", "rd/rd2man-lib", "--man-section=3", input)
+
+      assert_predicate(status, :success?, stderr)
+      assert_match(/^\.TH .*SAMPLE 3 "/, stdout)
+    end
+  end
+
+  private
+
+  def run_rd2(extra_libdir, *args)
+    ruby = RbConfig.ruby
+    rubylib = [@libdir, extra_libdir, ENV["RUBYLIB"]].compact.join(File::PATH_SEPARATOR)
+    Open3.capture3({ "RUBYLIB" => rubylib }, ruby, @rd2, *args)
+  end
+
+  def write_fake_formatter_files(tmpdir)
+    File.write(File.join(tmpdir, "fake_rd2_visitor.rb"), <<~RUBY)
+      class FakeRD2Visitor
+        OUTPUT_SUFFIX = "txt"
+
+        attr_accessor :input_filename, :filename, :charcode, :lang, :flag
+        attr_reader :include_suffix
+
+        def initialize
+          @include_suffix = []
+          @flag = false
+        end
+
+        def self.version
+          "FakeRD2Visitor 1.0"
+        end
+
+        def visit(_tree)
+          @flag ? "flag-on\\n" : "flag-off\\n"
+        end
+      end
+
+      $Visitor_Class = FakeRD2Visitor
+      $RD2_Sub_OptionParser = "fake_rd2_opt"
+    RUBY
+
+    File.write(File.join(tmpdir, "fake_rd2_opt.rb"), <<~RUBY)
+      q = ARGV.options
+      q.on_tail("--fake-flag", "toggle fake flag") do
+        $Visitor.flag = true
+      end
+    RUBY
+  end
+end

data/test/test-rd2html5-lib.rb

@@ -0,0 +1,67 @@
+require "test/unit"
+
+require "rd/rd2html5-lib"
+require "rd/tree"
+require "rd/block-element"
+require "rd/desclist"
+require "rd/methodlist"
+require "rd/inline-element"
+require "rd/rd-struct"
+
+include RD
+
+class TestRD2HTML5Visitor < Test::Unit::TestCase
+  def setup
+    @vis = RD2HTML5Visitor.new
+    @vis.class.module_eval do
+      public :xml_decl
+      public :doctype_decl
+      public :html_open_tag
+      public :html_content_type
+    end
+  end
+
+  def test_html5_head_pieces
+    @vis.lang = "en"
+    @vis.charset = "utf-8"
+
+    assert_equal(nil, @vis.xml_decl)
+    assert_equal("<!DOCTYPE html>", @vis.doctype_decl)
+    assert_equal('<html lang="en">', @vis.html_open_tag)
+    assert_equal('<meta charset="utf-8">', @vis.html_content_type)
+  end
+
+  def test_apply_to_headline_uses_id_without_anchor_tag
+    tr = Tree.new_with_document_struct(DocumentStructure::RD)
+    tr.root = DocumentElement.new
+    headline = nil
+    tr.root.build do
+      headline = new Headline, 1 do
+        new StringElement, "headline"
+      end
+    end
+    @vis.prepare_labels(tr, "label:")
+
+    assert_equal('<h1 id="label:0">headline</h1><!-- RDLabel: "headline" -->',
+                 @vis.apply_to_Headline(headline, ["headline"]))
+  end
+
+  def test_apply_to_desclist_item_uses_id_on_dt
+    tr = Tree.new_with_document_struct(DocumentStructure::RD)
+    tr.root = DocumentElement.new
+    item = nil
+    tr.root.build do
+      new DescList do
+        item = new DescListItem do
+          make_term do
+            new StringElement, "term"
+          end
+        end
+      end
+    end
+    @vis.prepare_labels(tr, "label:")
+
+    assert_equal('<dt id="label:0">term</dt><!-- RDLabel: "term" -->',
+                 @vis.apply_to_DescListItem(item, ["term"], []))
+  end
+end

data/test/test-rd2man-lib.rb

@@ -0,0 +1,54 @@
+require "test/unit"
+require "rd/rd2man-lib"
+require "rd/tree"
+require "rd/block-element"
+require "rd/rd-struct"
+
+include RD
+
+class TestRD2MANLib < Test::Unit::TestCase
+  def test_default_man_section_is_1
+    visitor = RD2MANVisitor.new
+
+    assert_equal("1", visitor.output_suffix)
+  end
+
+  def test_man_section_changes_output_suffix_and_th_header
+    visitor = RD2MANVisitor.new
+    visitor.man_section = "3"
+    visitor.input_filename = "rdtool.rd"
+
+    tree = Tree.new_with_document_struct(DocumentStructure::RD)
+    tree.root = DocumentElement.new
+
+    output = visitor.visit(tree)
+
+    assert_equal("3", visitor.output_suffix)
+    assert_match(/^\.TH RDTOOL 3 "/, output)
+  end
+
+  def test_th_header_uses_basename_instead_of_full_path
+    visitor = RD2MANVisitor.new
+    visitor.input_filename = "/tmp/path/to/rd2.rd"
+
+    tree = Tree.new_with_document_struct(DocumentStructure::RD)
+    tree.root = DocumentElement.new
+
+    output = visitor.visit(tree)
+
+    assert_match(/^\.TH RD2 1 "/, output)
+  end
+
+  def test_th_header_uses_output_basename_for_stdin_input
+    visitor = RD2MANVisitor.new
+    visitor.input_filename = "-"
+    visitor.filename = "/tmp/output/rd2"
+
+    tree = Tree.new_with_document_struct(DocumentStructure::RD)
+    tree.root = DocumentElement.new
+
+    output = visitor.visit(tree)
+
+    assert_match(/^\.TH RD2 1 "/, output)
+  end
+end

data/test/test-rdswap-cli.rb

@@ -0,0 +1,49 @@
+require "test/unit"
+require "open3"
+require "rbconfig"
+require "tmpdir"
+require "fileutils"
+
+class TestRDSwapCLI < Test::Unit::TestCase
+  def setup
+    @root = File.expand_path("..", __dir__)
+    @rdswap = File.join(@root, "bin", "rdswap.rb")
+  end
+
+  def test_help_exits_successfully_without_warnings
+    _stdout, stderr, status = Open3.capture3(RbConfig.ruby, @rdswap, "-h")
+
+    assert_predicate(status, :success?, stderr)
+    assert_no_match(/warning:/i, stderr)
+  end
+
+  def test_generates_translated_script
+    Dir.mktmpdir("rdswap") do |tmpdir|
+      source = File.join(tmpdir, "sample.rb")
+      translation = File.join(tmpdir, "sample.ja")
+
+      File.write(source, <<~RUBY)
+        puts "hello"
+        =begin
+        original
+        =end
+        puts "bye"
+      RUBY
+
+      File.write(translation, <<~TEXT)
+        =begin
+        translated
+        =end
+      TEXT
+
+      _stdout, stderr, status = Open3.capture3(RbConfig.ruby, @rdswap, source, translation)
+
+      assert_predicate(status, :success?, stderr)
+      output = File.read("#{source}.ja")
+      assert_match(/puts "hello"/, output)
+      assert_match(/translated/, output)
+      assert_match(/puts "bye"/, output)
+      assert_no_match(/original/, output)
+    end
+  end
+end

data/test/test-reference-resolver.rb

@@ -145,7 +145,7 @@ class TestReferenceResolver < Test::Unit::TestCase
     ref = nil
     de.build do
       new TextBlock do
-        se = StringElement.new "label"
+        StringElement.new "label"
         ref = new Reference, label_ext
       end
     end

data/utils/rd-mode.el

@@ -1,13 +1,15 @@
+;;; rd-mode.el --- Major mode for RD editing
 ;;;
-;;; rd-mode.el
-;;; Major mode for RD editing
-;;; 
 ;;; NOTE: experimental.
+;;; $Lastupdate: 2018-08-19 23:51:49$
 
-;; Copyright (C) 1999 Koji Arai, Toshiro Kuwabara.
+;; Copyright (C) 1999-2018 Koji Arai, Toshiro Kuwabara, Youhei SASAKI
 
-;; Author: Koji Arai, Toshiro Kuwabara
+;; Author: Koji Arai, Toshiro Kuwabara, Youhei SASAKI
 ;; Created: Sat Nov 27 00:08:12 1999
+;; Version: 0.6.38
+;; Keywords: rd
+;; URL: https://github.com/uwabami/rdtool/blob/master/utils/rd-mode.el
 
 ;; This file is not part of GNU Emacs, but the same permissions apply.
 
@@ -23,8 +25,8 @@
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor
+;; Boston, MA 02110-1301, USA.
 
 ;; Settings:
 ;;
@@ -45,6 +47,28 @@
 (defvar rd-mode-hook nil
   "Hooks run when entering `rd-mode' major mode")
 
+(defvar rd-mode-map
+  (let ((m (make-sparse-keymap)))
+    (define-key m (kbd "TAB")       'rd-indent-line)
+    (define-key m (kbd "C-j")       'rd-newline-and-indent)
+    (define-key m (kbd "C-c C-v")   'rd-cite-region)
+    (define-key m (kbd "C-c C-i e") 'rd-insert-emphasis)
+    (define-key m (kbd "C-c C-i c") 'rd-insert-code)
+    (define-key m (kbd "C-c C-i v") 'rd-insert-var)
+    (define-key m (kbd "C-c C-i k") 'rd-insert-keyboard)
+    (define-key m (kbd "C-c C-i i") 'rd-insert-index)
+    (define-key m (kbd "C-c C-i r") 'rd-insert-ref)
+    (define-key m (kbd "C-c C-i u") 'rd-insert-reftourl)
+    (define-key m (kbd "C-c C-i f") 'rd-insert-footnote)
+    (define-key m (kbd "C-c C-i b") 'rd-insert-verb)
+    (define-key m (kbd "C-c C-y")   'rd-yank-as-url)
+    (define-key m (kbd "C-c M-y")   'rd-yank-pop-as-url)
+    (define-key m (kbd "C-c C-u")   'rd-insert-url)
+    (define-key m (kbd "M-C-m")     'rd-intelligent-newline)
+    m)
+  "Keymap used in rd-mode.")
+
+;;;###autoload
 (define-derived-mode rd-mode text-mode "RD"
   "Major mode for RD editing.
 \\{rd-mode-map}"
@@ -52,7 +76,7 @@
   (setq paragraph-separate "=+\\|\\++\\|[ \t\n\^L]*$")
   (make-local-variable 'paragraph-start)
   (setq paragraph-start "=+\\|\\++\\|[ \t\n\^L]")
-  (make-local-variable 'require-final-newline)  
+  (make-local-variable 'require-final-newline)
   (setq require-final-newline t)
   (make-local-variable 'font-lock-defaults)
   (setq font-lock-defaults '((rd-font-lock-keywords) t nil))
@@ -64,7 +88,6 @@
   (add-hook (make-local-variable 'write-contents-hooks) 'rd-strip-cr-on-top)
   (add-hook (make-local-variable 'after-save-hook) 'rd-rehide-endline)
   (rd-hide-other-block-all)
-  (rd-setup-keys)
   (setq indent-tabs-mode nil)
   (setq imenu-create-index-function 'rd-imenu-create-index)
   (run-hooks 'rd-mode-hook)
@@ -114,25 +137,6 @@
      0 rd-description-face)
    ))
 
-(defun rd-setup-keys ()
-  (interactive)
-  (define-key rd-mode-map "\t" 'rd-indent-line)
-  (define-key rd-mode-map "\C-j" 'rd-newline-and-indent)
-  (define-key rd-mode-map "\C-c\C-v" 'rd-cite-region)
-  (define-key rd-mode-map "\C-c\C-ie" 'rd-insert-emphasis)
-  (define-key rd-mode-map "\C-c\C-ic" 'rd-insert-code)
-  (define-key rd-mode-map "\C-c\C-iv" 'rd-insert-var)
-  (define-key rd-mode-map "\C-c\C-ik" 'rd-insert-keyboard)
-  (define-key rd-mode-map "\C-c\C-ii" 'rd-insert-index)
-  (define-key rd-mode-map "\C-c\C-ir" 'rd-insert-ref)
-  (define-key rd-mode-map "\C-c\C-iu" 'rd-insert-reftourl)
-  (define-key rd-mode-map "\C-c\C-if" 'rd-insert-footnote)
-  (define-key rd-mode-map "\C-c\C-ib" 'rd-insert-verb)
-  (define-key rd-mode-map "\C-c\C-y" 'rd-yank-as-url)
-  (define-key rd-mode-map "\C-c\M-y" 'rd-yank-pop-as-url)
-  (define-key rd-mode-map "\C-c\C-u" 'rd-insert-url)
-  (define-key rd-mode-map "\M-\C-m" 'rd-intelligent-newline))
-
 (defun rd-strip-cr-on-top ()
   (save-excursion
     (widen)
@@ -188,7 +192,7 @@
     (set-buffer-modified-p mod))
   (setq selective-display t
 	selective-display-ellipses rd-selective-display-ellipses))
- 
+
 (defun rd-show-other-block ()
   "Shows lines not in RD format before current point."
   (interactive)
@@ -338,7 +342,7 @@
     (beginning-of-line)
     (looking-at "--- +\\| *\\(\\* +\\|([0-9]+) +\\)?")
     (length (buffer-substring (match-beginning 0)(match-end 0)))))
-  
+
 (defun rd-cite-region (beg end)
   "Make region into Verbatim."
   (interactive "r*")
@@ -359,7 +363,7 @@
                (rd-indent-region beg end prev-indent))
               (t
                (goto-char end)))))))
-  
+
 (defun rd-indent-region (beg end &optional indent)
   "Make the indent of region deeper by INDENT."
   (interactive "r*")
@@ -417,7 +421,7 @@
           )
     (end-of-line)
     (newline)
-    (if item (insert-string item) )
+    (if item (insert item) )
     )
   )
 
@@ -425,7 +429,7 @@
   (let ((root '(nil . nil))
         cur-alist
         (cur-level 0)
-        (pattern "^\\(=+\\)[ \t\v\f]*\\(.*?\\)[ \t\v\f]*$")
+        (pattern "^\\(=+\\|---\\)[ \t\v\f]*\\(.*?\\)[ \t\v\f]*$")
         (empty-heading "-")
         (self-heading ".")
         pos level heading alist)
@@ -461,6 +465,8 @@
                   cur-level level))))))
     (cdr root)))
 
+;;;###autoload
+(add-to-list 'auto-mode-alist '("\\.rd\\'" . rd-mode))
+
 (provide 'rd-mode)
 ;;; rd-mode.el ends here
-