olddoc 1.5.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5ed269def320cfe052cabbe1ccaf952cb67ea35f218f71c697e64602e53160a
-  data.tar.gz: a08e13570e7b1c29314d9d9d1a84dfef34eaa3b142d770037acc92a6261e2176
+  metadata.gz: 1400bf9d3e94d012404961bf1f665ba6006eb0edc8bdc5e55c178ef068893828
+  data.tar.gz: a3c8a0d8e9642af7c00f92592c5d61e52a430a321b5e26aac604fac1f9b05b40
 SHA512:
-  metadata.gz: 1b8668a99554c443cedf069975c1bcdec7e8ebdc56d5527f799400b93c7e27008d11c007e281fe1d5f638aff19fffbdd0b475130fa3d1b2d28a2b3153cc27b4f
-  data.tar.gz: 23a4fa35c6a4b1f099917db814312a15af705c9f24fe5211a152ba7b72da6a66ed4111fedc1ed69735d4b564f1f62b5a700c6d9af78cb4ed9e0deaf879a3154c
+  metadata.gz: a48ad6a40397a4fa28eccd7c1346f7eb65d8625e73c2be73585226fe7c6acf858e6175043fe93021f05bf8a2ff3b57cd3a0c9e9db584cc046bb680b64f41ba88
+  data.tar.gz: 10f049dc25df53ef808a9b8afe74f80889f61f116938c0573dab427299c622608e7b7aed775ad9e530421cc465647effe39d41f4fb03658e9a2759cbaf9e32b4

data/.olddoc.yml

@@ -1,11 +1,20 @@
 ---
-cgit_url: https://80x24.org/olddoc.git
-git_url: git://80x24.org/olddoc.git
+cgit_url:
+- https://80x24.org/olddoc.git
+- https://ou63pmih66umazou.onion/olddoc.git
+git_url: https://80x24.org/olddoc.git
 rdoc_url: https://80x24.org/olddoc/
-ml_url: https://80x24.org/olddoc-public/
-nntp_url: nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
+ml_url:
+- https://80x24.org/olddoc-public/
+- http://ou63pmih66umazou.onion/olddoc-public/
+nntp_url:
+- nntps://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
+- nntp://ou63pmih66umazou.onion/inbox.comp.lang.ruby.olddoc
+imap_url:
+- imaps://news.public-inbox.org/inbox.comp.lang.ruby.olddoc.0
+- imap://ou63pmih66umazou.onion/inbox.comp.lang.ruby.olddoc.0
 merge_html:
   olddoc_1: Documentation/olddoc.1.html
   olddoc_5: Documentation/olddoc.5.html
 public_email: olddoc-public@80x24.org
-source_code: git clone git://80x24.org/olddoc
+source_code: git clone https://80x24.org/olddoc.git

data/Documentation/.gitignore

@@ -2,3 +2,4 @@
 *.1
 *.5
 *.html
+*.txt

data/Documentation/GNUmakefile

@@ -1,26 +1,32 @@
-# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# Copyright (C) 2015-2019 all contributors <olddoc-public@80x24.org>
 # License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 all::
 
 INSTALL = install
-PANDOC = pandoc
-PANDOC_OPTS = -f markdown --email-obfuscation=none
-pandoc = $(PANDOC) $(PANDOC_OPTS)
-pandoc_html = $(pandoc) --toc -t html --no-wrap
+POD2MAN = pod2man
+-include ../GIT-VERSION-FILE
+release := olddoc $(VERSION)
+POD2MAN_OPTS = -v -r '$(release)' --stderr -d 1994-10-02 -c 'olddoc user manual'
+pod2man = $(POD2MAN) $(POD2MAN_OPTS)
+POD2TEXT = pod2text
+POD2TEXT_OPTS = --stderr
+pod2text = $(POD2TEXT) $(POD2TEXT_OPTS)
 
+m1 =
+m1 += olddoc.1
 
-man1 := olddoc.1
-man5 := olddoc.5
-man7 :=
+m5 =
+m5 += olddoc.5
 
-html1 := $(addsuffix .html, $(man1))
-html5 := $(addsuffix .html, $(man5))
-html7 := $(addsuffix .html, $(man7))
+m7 =
+
+man1 := $(m1)
+man5 := $(m5)
+man7 := $(m7)
 
 all:: man
 
 man: $(man1) $(man5) $(man7)
-html: $(html1) $(html5) $(html7)
 
 prefix ?= $(HOME)
 mandir ?= $(prefix)/share/man
@@ -30,24 +36,47 @@ man7dir = $(mandir)/man7
 
 gem-man: man
 	$(INSTALL) -d -m 755 ../man
-	test -z "$(man1)" || $(INSTALL) -m 644 $(man1) ../man
-	test -z "$(man5)" || $(INSTALL) -m 644 $(man5) ../man
+	$(INSTALL) -m 644 $(man1) ../man
+	$(INSTALL) -m 644 $(man5) ../man
 	test -z "$(man7)" || $(INSTALL) -m 644 $(man7) ../man
 
 install-man: man
-	$(INSTALL) -d -m 755 $(DESTDIR)$(mandir)
-	test -z "$(man1)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
-	test -z "$(man5)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 	test -z "$(man7)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
-	test -z "$(man1)" || $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
-	test -z "$(man5)" || $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
+	$(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
+	$(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
 	test -z "$(man7)" || $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
 
-%: %.txt
-	$(pandoc) -s -t man < $< > $@+ && mv $@+ $@
+%.1 : %.1.pod
+	$(pod2man) -s 1 $< $@+
+	mv $@+ $@
+
+%.5 : %.5.pod
+	$(pod2man) -s 5 $< $@+
+	mv $@+ $@
+
+%.7 : %.7.pod
+	$(pod2man) -s 7 $< $@+
+	mv $@+ $@
+
+mantxt = $(addsuffix .txt, $(m1) $(m5) $(m7))
+
+txt :: $(mantxt)
+
+all :: txt
+
+%.txt : %.pod
+	$(pod2text) $< $@+
+	touch -r $< $@+
+	mv $@+ $@
 
-%.html : %.txt
-	$(pandoc_html) < $< > $@+ && mv $@+ $@
+html : podtxt2html $(mantxt)
+	./podtxt2html $(mantxt)
 
 clean::
-	$(RM) $(man1) $(man5) $(man7) $(html1) $(html5) $(html7)
+	$(RM) $(man1) $(man5) $(man7)
+	$(RM) $(addsuffix .txt.gz, $(m1) $(m5) $(m7))
+	$(RM) $(addsuffix .txt, $(m1) $(m5) $(m7))
+	$(RM) $(addsuffix .html, $(subst .,_,$(m1) $(m5) $(m7)))
+	$(RM) $(addsuffix .html.gz, $(subst .,_,$(m1) $(m5) $(m7)))

data/Documentation/olddoc.1.pod

@@ -0,0 +1,21 @@
+=head1 NAME
+
+olddoc - old-fashioned RDoc HTML generator
+
+=head1 SYNOPSYS
+
+olddoc prepare
+
+rdoc -f oldweb
+
+rdoc -f dark216
+
+=head1 DESCRIPTION
+
+olddoc features dark216, and old-fashioned RDoc HTML generator.
+You can also use "olddoc prepare" to generate NEWS files from
+git tags.
+
+=head1 SEE ALSO
+
+L<olddoc(5)>

data/Documentation/{olddoc.5.txt → olddoc.5.pod}

@@ -1,29 +1,26 @@
-% olddoc(1) olddoc user manual
-
-# NAME
+=head1 NAME
 
 .olddoc.yml - olddoc config file format
 
-# SYNOPSIS
+=head1 SYNOPSIS
 
 A YAML file in the top-level project directory named ".olddoc.yml"
 
-# DESCRIPTION
+=head1 DESCRIPTION
 
 As olddoc favors consistency over configuration, there is minimal
 configuration to deal with.
 
-# KEYS
+=head1 KEYS
 
-`rdoc_url`, `cgit_url`, and `nntp_url` should be obvious
+`rdoc_url`, `cgit_url`, `imap_url`, and `nntp_url` should be obvious
 
 `merge_html` is a key-value mapping of (empty) RDoc source files to an
 HTML file that will be merged into RDoc after-the-fact.  It is useful
 for merging non-RDoc generated HTML into the project.
 
-`ml_url` is the mailing list archive location.
-`public_email` is the email address of a publically archived mailing list
-at `ml_url`
+`ml_url` is the mail archive location.
+`public_email` is the email address of a mail archived at `ml_url`
 
 As of olddoc 1.2.0, `ml_url` and `nntp_url` may be YAML arrays
 with multiple URLs.
@@ -33,6 +30,6 @@ commands or URLs.  This allows users of arbitrary version
 control systems to specify instructions for getting the code
 and not assume users are familiar with any particular system.
 
-# SEE ALSO
+=head1 SEE ALSO
 
-olddoc(1)
+L<olddoc(1)>

data/Documentation/podtxt2html

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby
+# Copyright (C) 2019 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
+
+# pod2html isn't to my liking, and we need to generate anchors
+# compatible with what pandoc was generating to avoid breaking
+# links.  Takes pod2text-generated text and transforms it to
+# an HTML fragment
+
+txts = ARGV
+links = {}
+txts.each do |f|
+  if f =~ /(\A[\w\-]+)\.(\d)\.txt\z/
+    base = $1
+    section = $2
+    links["#{base}(#{section})"] = "#{base}_#{section}.html"
+  else
+    abort "#{f} is not of <BASE>.<SECTION>.txt\n"
+  end
+end
+
+linkre = links.keys.map { |x| Regexp.escape(x) }.join('|')
+
+sections = '[A-Z][A-Z ]+'
+txts.each do |f|
+  str = File.read(f)
+  str = str.split(/^(#{sections})$/mo)
+  str = str.map! do |s|
+    case s
+    when /\A(#{sections})$/o
+      # this is to be compatible with HTML fragments pandoc used
+      sec = $1
+      anchor = sec.downcase.tr(' ', '-')
+      %Q(<h1\nid=#{anchor}>#{sec}</h1>)
+    else
+      s.encode!(xml: :text)
+      s.gsub!(/\b(#{linkre})/mo) do |m|
+        manref = $1
+        if url = links[manref]
+          %Q(<a\nhref="#{url}">#{manref}</a>)
+        else
+          manref
+        end
+      end
+      s.rstrip!
+      s.empty? ? '' : "<pre>#{s}</pre>"
+    end # case s
+  end.join
+
+  html = f.sub(/.txt\z/, '.html')
+  tmp = html + '+'
+  File.open(tmp, 'w') { |f| f.write(str) }
+  File.rename(tmp, html)
+end

data/GIT-VERSION-GEN

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
-# Copyright (C) 2016 all contributors <olddoc-public@80x24.org>
+# Copyright (C) 2016-2019 all contributors <olddoc-public@80x24.org>
 # License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 # frozen_string_literal: true
 CONSTANT = "Olddoc::VERSION"
 RVF = "lib/olddoc/version.rb"
 GVF = "GIT-VERSION-FILE"
-DEF_VER = "v1.5.1"
+DEF_VER = "v1.9.0"
 vn = DEF_VER.dup
 
 # First see if there is a version file (included in release tarballs),

data/GNUmakefile

@@ -41,7 +41,7 @@ doc: $(placeholders)
 	$(MAKE) -C Documentation html
 	rm -rf doc
 	olddoc prepare
-	rdoc --debug -f oldweb
+	rdoc --debug -f dark216
 	olddoc merge
 	ln NEWS.atom.xml doc/
 

data/README

@@ -3,15 +3,17 @@
 olddoc contains old-fashioned document generators for those who do not
 wish to impose bloated, new-fangled web cruft on their readers.
 
-olddoc contains oldweb, an HTML generator without any images, frames,
-CSS, or JavaScript.  It is designed for users of text-based browsers
-and/or low-bandwidth connections.  oldweb focuses on text as it is
-the lowest common denominator for accessibility and compatibility
+olddoc contains dark216, a HTML generator without any images, frames,
+or JavaScript.  It is designed for users of text-based browsers
+and/or low-bandwidth connections; yet respects user preference for
+light color schemes in new CSS browsers while favoring darkness for
+power savings on OLED and CRT displays.  dark216 focuses on text as
+it is the lowest common denominator for accessibility and compatibility
 with people and hardware.
 
 == Reasons
 
-* No CSS.  Encouraging users to use CSS leads to problems like
+* No CSS required.  Encouraging users to use CSS leads to problems like
   copy-paste hijacking: https://thejh.net/misc/website-terminal-copy-paste
   External CSS also increases page load time as it often blocks page
   rendering.  Asynchronous loading of CSS also causes accessibility
@@ -38,7 +40,7 @@ missing out!
 
 	gem install olddoc
 	cd $ANY_RDOC_USING_RUBY_PROJECT
-	rdoc -f oldweb
+	rdoc -f dark216
 
 You can also use olddoc to generate NEWS entries
 assuming you have git tags, a README file and .olddoc.yml
@@ -52,7 +54,7 @@ such as pandoc(1).  This requries an appropriately configured
 
 == Source code
 
-	git clone git://80x24.org/olddoc
+	git clone https://80x24.org/olddoc.git
 
 Please use git-format-patch(1) and git-send-email(1) distributed with
 the git(7) suite for generating and sending patches.  Please format
@@ -62,14 +64,15 @@ with git(7)) and send them via email to <olddoc-public@80x24.org>
 == Contact
 
 All feedback (comments, results, feature requests, bug reports, patches,
-pull-requests) via plain-text mail to the mailing list is very much
-appreciated.
+pull-requests) via plain-text email is very much appreciated.
 
-Please send plain-text mail to the list at <olddoc-public@80x24.org>
+Please send plain-text email to us at <olddoc-public@80x24.org>
+Use reply-to-all as we do not require any sort of subscription.
 HTML will not be read.  olddoc is for GUI-phobes, by GUI-phobes.
-Mailing list archives available at https://80x24.org/olddoc-public/
-and nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
-No subscription will ever be necessary to post to the mailing list.
+We archive all of our mail publically at:
+
+	https://80x24.org/olddoc-public/
+	nntp://news.public-inbox.org/inbox.comp.lang.ruby.olddoc
 
 == License
 

data/Rakefile

@@ -21,7 +21,7 @@ task :rsync_docs do
     gz
   end
 
-  files = `git ls-files Documentation/*.txt`.split(/\n/)
+  files = `git ls-files -o Documentation/*.txt`.split(/\n/)
   files.concat(top)
   files.concat(%w(NEWS NEWS.atom.xml))
   files.concat(Dir["doc/*.html"].to_a)

data/bin/olddoc

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
+# Copyright (C) 2015,2019 all contributors <olddoc-public@80x24.org>
 $stderr.sync = $stdout.sync = true
 tasks = %w(prepare merge)
 usage = "Usage: #{File.basename($0)} [#{tasks.join('|')}]"
@@ -10,6 +10,8 @@ when "prepare"
   Olddoc::Prepare.new(opts).run
 when "merge"
   Olddoc::Merge.new(opts).run
+when "man2html"
+  Olddoc::Man2HTML.new(opts).run(ARGV[1..-1])
 else
   warn "#{$0.inspect} #{ARGV.inspect} not understood"
   abort usage

data/lib/dark216.rb

@@ -0,0 +1,41 @@
+# Copyright (C) 2019 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
+
+# Loosely derived from Darkfish in the main rdoc distribution
+require_relative 'oldweb'
+
+# dark216 is an \RDoc template and not intended as a programming API.
+# It respect prefers-color-scheme:light on newer browsers with CSS
+# support, but favors darkness for power-savings.
+# You may specify it as an \RDoc formatter:
+#
+#   rdoc -f dark216 ...
+class Dark216 < Oldweb
+  RDoc::RDoc.add_generator(self) # :nodoc:
+  include ERB::Util # :nodoc:
+
+  # description of the generator
+  DESCRIPTION = 'minimal dark HTML generator'
+
+  # default to a dark, web-safe (216 color) palette for power-savings.
+  # Color-capable browsers can respect the prefers-color-scheme:light
+  # @media query (browser support a work-in-progress)
+  STYLE = <<'EOF'.gsub(/^\s*/m, '').delete!("\n") # :nodoc:
+@media screen {
+  *{background:#000;color:#ccc}
+  a{color:#69f;text-decoration:none}
+  a:visited{color:#96f}
+}
+@media screen AND (prefers-color-scheme:light) {
+  *{background:#fff;color:#333}
+  a{color:#00f;text-decoration:none}
+  a:visited{color:#808}
+}
+EOF
+
+  def initialize(*args) # :nodoc:
+    super
+    @oldweb_style = STYLE
+  end
+end
+# :startdoc:

data/lib/olddoc.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
+# Copyright (C) 2015-2019 all contributors <olddoc-public@80x24.org>
 # License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 module Olddoc # :nodoc:
   autoload :Gemspec, 'olddoc/gemspec'
@@ -8,6 +8,7 @@ module Olddoc # :nodoc:
   autoload :NewsRdoc, 'olddoc/news_rdoc'
   autoload :Prepare, 'olddoc/prepare'
   autoload :Readme, 'olddoc/readme'
+  autoload :Man2HTML, 'olddoc/man2html'
 
   def self.config(path = ".olddoc.yml")
     File.readable?(path) and return YAML.load(File.read(path))
@@ -16,3 +17,4 @@ module Olddoc # :nodoc:
   end
 end
 require_relative 'oldweb'
+require_relative 'dark216'

data/lib/olddoc/history.rb

@@ -9,7 +9,7 @@ module Olddoc::History # :nodoc:
 
   # returns a cgit URI for a given +tag_name+
   def tag_uri(tag_name)
-    uri = @cgit_uri.dup
+    uri = @cgit_uri[0].dup
     uri.path += "/tag/"
     uri.query = "id=#{tag_name}"
     uri

data/lib/olddoc/man2html.rb

@@ -0,0 +1,149 @@
+# Copyright (C) 2019 all contributors <olddoc-public@80x24.org>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
+# frozen_string_literal: true
+require 'digest'
+require 'optparse'
+
+# linkifier for manpages rendered to a terminal.  man2html(1) and
+# groff generate too much style
+
+class Olddoc::Man2HTML # :nodoc:
+  SALT = rand
+  LINK_RE = %r{([\('!])?\b((?:ftps?|https?|nntps?|gopher|imaps?)://
+     [\@:\w\.-]+(?:/
+     (?:[a-z0-9\-\._~!\$\&\';\(\)\*\+,;=:@/%]*)
+     (?:\?[a-z0-9\-\._~!\$\&\';\(\)\*\+,;=:@/%]+)?
+     (?:\#[a-z0-9\-\._~!\$\&\';\(\)\*\+,;=:@/%\?]+)?
+     )?
+    )}xi
+
+  PAIRS = {
+  "(" => %r/(\)[\.,;\+]?)\z/, # Markdown (,), Ruby (+) (, for arrays)
+  "'" => %r/('[\.,;\+]?)\z/, # Perl / Ruby
+  "!" => %r/(![\.,;\+]?)\z/, # Perl / Ruby
+  }
+
+  def initialize(opts) # :nodoc:
+  end
+
+  def run(argv) # :nodoc:
+    out = $stdout
+    OptionParser.new("", 24, '  ') do |opts|
+      opts.on('-o', '--output PATH', 'output to given file') { |path|
+        out = File.open(path, 'w')
+      }
+      opts.parse!(argv)
+    end
+    argv[0] or abort 'manpage required'
+    cols = '72'
+    env = ENV.to_hash
+    env.merge!({ 'COLUMNS' => cols, 'MANWIDTH' => cols, 'TERM' => 'dumb' })
+
+    # note: I don't care for the styles groff and man2html throw
+    # on us, I just want indented and wrapped text with <a hrefs>
+    # for URLs.
+
+    # try man-db options, first:
+    str = IO.popen(env, ['man', '--nh', '--nj', *argv], &:read)
+
+    if str.empty? || !$?.success?
+      str = IO.popen(env, ['man', *argv], &:read)
+    end
+    if $?.success?
+      sections = '[A-Z][A-Z ]+'
+      str = str.split(/^(#{sections})$/mo)
+
+      str = str.map! do |s|
+        case s
+        when /\A(#{sections})$/o
+          # this is to be compatible with HTML fragments pandoc used
+          sec = $1
+          anchor = sec.downcase.tr(' ', '-')
+          "<h1\nid=#{anchor.encode(xml: :attr)}>#{sec}</h1>"
+        else
+          state = linkify_1(s)
+          s.encode!(xml: :text)
+          linkify_2(state, s)
+          s.rstrip!
+          s.empty? ? '' : "<pre>#{s}</pre>"
+        end
+      end.join
+
+      out.print(str)
+
+      # use mtime of the original source
+      if out.respond_to?(:path)
+        path = out.path
+        out.close
+        stat = src_input_stat(argv)
+        File.utime(stat.atime, stat.mtime, path) if stat
+      end
+    end
+  end
+
+  def src_input_stat(argv)
+    argv.reverse_each do |f|
+      next unless File.file?(f)
+      return File.stat(f)
+    end
+
+    argv.reverse_each do |f|
+      path = IO.popen(%W(man -w #{f}), &:read)
+      path.chomp!
+      next unless File.file?(path)
+      return File.stat(path)
+    end
+    nil
+  end
+
+  def linkify_1(str) # :nodoc:
+    state = {}
+    str.gsub!(LINK_RE) do
+      head = $1 || ''
+      url = $2.dup
+      tail = ''.dup
+
+      # it's fairly common to end URLs in messages with
+      # '.', ',' or ';' to denote the end of a statement;
+      # assume the intent was to end the statement/sentence
+      # in English
+      if re = PAIRS[head]
+        url.sub!(re, '')
+        tail = $1
+      elsif url.sub!(/(\))?([\.,;])\z/, '')
+        tail = $2
+        # require ')' to be paired with '('
+        if $1  # ')'
+          if url.index('(').nil?
+            tail = ")#{tail}"
+          else
+            url += ')'
+          end
+        end
+      elsif url !~ /\(/ && url.sub!(/\)\z/, '')
+        tail = ')'
+      end
+
+      # salt this, as this could be exploited to show
+      # links in the HTML which don't show up in the raw mail.
+      key = Digest::MD5.hexdigest("#{url}#{SALT}").freeze
+      state[key] = url
+      "#{head}OLD-LINK-#{key}#{tail}"
+    end
+    state
+  end
+
+  def linkify_2(state, str) # :nodoc:
+    # Added "OLD-LINK-" prefix to avoid false-positives on git commits
+    str.gsub!(/\bOLD-LINK-([a-f0-9]{32})\b/) do
+      key = $1
+      url = state[key]
+      if url
+        %Q{<a\nhref=#{url.encode(xml: :attr)}>#{url.encode(xml: :text)}</a>}
+      else
+        # false positive or somebody tried to mess with us
+        key
+      end
+    end
+  end
+end

data/lib/olddoc/news_atom.rb

@@ -32,9 +32,9 @@ module Olddoc::NewsAtom # :nodoc:
   def news_atom_xml
     project_name, short_desc, _ = readme_metadata
     new_tags = tags[0,10]
-    atom_uri = @rdoc_uri.dup
+    atom_uri = @rdoc_uri[0].dup
     atom_uri.path += "NEWS.atom.xml"
-    news_uri = @rdoc_uri.dup
+    news_uri = @rdoc_uri[0].dup
     news_uri.path += "NEWS.html"
 
     dst = ''

data/lib/olddoc/prepare.rb

@@ -12,8 +12,8 @@ class Olddoc::Prepare # :nodoc:
     cgit_url = opts['cgit_url']
     rdoc_url && cgit_url or
       abort "rdoc_url and cgit_url required in .olddoc.yml for `prepare'"
-    @rdoc_uri = URI.parse(rdoc_url)
-    @cgit_uri = URI.parse(cgit_url)
+    @rdoc_uri = Array(rdoc_url).map { |u| URI.parse(u) }
+    @cgit_uri = Array(cgit_url).map { |u| URI.parse(u) }
     @name, @short_desc = readme_metadata
   end
 

data/lib/oldweb.rb

@@ -5,7 +5,7 @@ require 'rdoc'
 require 'erb'
 require 'pathname'
 require 'yaml'
-require 'uri'
+require 'cgi'
 
 # oldweb is an \RDoc template and not intended as a programming API.
 # You may specify it as an \RDoc formatter:
@@ -73,12 +73,25 @@ class Oldweb
     noindex = @old_cfg['noindex'] and noindex.each { |k| ni[k] = true }
     @old_cfg['noindex'] = ni
 
-    if cgit_url = @old_cfg['cgit_url']
-      cgit_url += '/tree/%s' # path name
-      tag = @git_tag and cgit_url << "id=#{URI.escape(tag)}"
-      cgit_url << '#n%d' # lineno
-      @old_vcs_url = cgit_url
+    cgit_url = Array(@old_cfg['cgit_url'])
+    source = @old_cfg['source_code'] ||= []
+    if source.empty?
+      source << "git clone #{cgit_url[0]}" if cgit_url[0]
+      git_url = @old_cfg['git_url']
+      if git_url && git_url != cgit_url[0]
+        source << "git clone #{git_url}"
+      end
+    end
+
+    if cgit_url[0]
+      cgit_url.each do |u|
+        u += '/tree/%s' # path name
+        tag = @git_tag and u << "id=#{CGI.escape(tag)}"
+        u << '#n%d' # lineno
+      end
+      @old_vcs_url = cgit_url[0]
     end
+    @oldweb_style = nil # used by dark216
   end
 
   def generate # :nodoc:
@@ -269,7 +282,11 @@ class Oldweb
       erbout = "_erbout_#{file_var}"
     end
 
-    template = klass.new(template, nil, '<>', erbout)
+    if ERB.instance_method(:initialize).parameters.assoc(:key)
+      template = klass.new(template, trim_mode: '<>', eoutvar: erbout)
+    else
+      template = klass.new(template, nil, '<>', erbout)
+    end
     @template_cache[file] = template
   end
 
@@ -280,7 +297,7 @@ class Oldweb
   def method_srclink(m) # :nodoc:
     url = @old_vcs_url or return ""
     line = m.line or return ""
-    path = URI.escape(m.file_name)
+    path = CGI.escape(m.file_name)
     %Q(<a href="#{url % [ path, line ]}">source</a>)
   end
 

data/lib/oldweb/_head.rhtml

@@ -8,4 +8,8 @@ type="application/atom+xml" /><%
 end
 %><meta
 http-equiv="Content-Type"
-content="text/html; charset=<%= @options.charset %>">
+content="text/html; charset=<%= @options.charset %>"><%
+if @oldweb_style
+%><style><%= @oldweb_style %></style><%
+end
+%>

data/lib/oldweb/_tail.rhtml

@@ -2,7 +2,7 @@
 public_email = @old_cfg['public_email']
 private_email = @old_cfg['private_email']
 source_code = Array(@old_cfg['source_code']).dup
-archive_urls = Array(@old_cfg['ml_url']) + Array(@old_cfg['nntp_url'])
+archive_urls = Array(@old_cfg.values_at(*%W(ml_url nntp_url imap_url))).flatten
 if url = archive_urls.shift %><hr /><pre>
 mail archives: <a
 href="<%= url %>"><%= url %></a><%
@@ -22,8 +22,11 @@ href="mailto:<%= private_email %>"><%= private_email %></a><%
   end
 
 if url_or_cmd = source_code.shift
+  url_or_cmd = url_or_cmd.sub(%r{\b(https?://\S+)}, "<a\nhref='\\1'>\\1</a>")
 %>
 source code: <%= url_or_cmd %>
-<% source_code.each do |x| %><%= "\t#{x}" %><% end
+<% source_code.each do |x| %><%=
+  %Q{\t#{x.sub(%r{\b(https?://\S+)}, %Q{<a\nhref='\\1'>\\1</a>})}}
+%><% end
 end
 %></pre><% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: olddoc
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.9.0
 platform: ruby
 authors:
 - olddoc hackers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -45,8 +45,9 @@ files:
 - COPYING
 - Documentation/.gitignore
 - Documentation/GNUmakefile
-- Documentation/olddoc.1.txt
-- Documentation/olddoc.5.txt
+- Documentation/olddoc.1.pod
+- Documentation/olddoc.5.pod
+- Documentation/podtxt2html
 - GIT-VERSION-GEN
 - GNUmakefile
 - INSTALL
@@ -55,9 +56,11 @@ files:
 - Rakefile
 - TODO
 - bin/olddoc
+- lib/dark216.rb
 - lib/olddoc.rb
 - lib/olddoc/gemspec.rb
 - lib/olddoc/history.rb
+- lib/olddoc/man2html.rb
 - lib/olddoc/merge.rb
 - lib/olddoc/news_atom.rb
 - lib/olddoc/news_rdoc.rb
@@ -104,8 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: old-fashioned Ruby documentation generator

data/Documentation/olddoc.1.txt

@@ -1,21 +0,0 @@
-% olddoc(1) olddoc user manual
-
-# NAME
-
-olddoc - old-fashioned RDoc HTML generator
-
-# SYNOPSIS
-
-`olddoc` prepare
-
-`rdoc` -f oldweb
-
-# DESCRIPTION
-
-olddoc features oldweb, and old-fashioned RDoc HTML generator.
-You can also use "olddoc prepare" to generate NEWS files from
-git tags.
-
-# SEE ALSO
-
-olddoc(5)