olddoc 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f71bf866c5df3305159326a07b851c4e6647474
-  data.tar.gz: 96be498a4ec4f3883b3d251047950ebdef47ca83
+  metadata.gz: 0f02849f5be5e9ecb197b2d0cbe22fe40ef5110a
+  data.tar.gz: a7deb5ecea035aa9430419617fd8c0dcd4e0d86a
 SHA512:
-  metadata.gz: f2ea9f583a932b846c104d4a88cd872bb381e3a30c4da51285d4e59fa91fcc7f91e5de94f6031f0fc96553c65215072a981477b6986857ab8d4736c56aa82636
-  data.tar.gz: 06ec969de7b22509de5dd9b07358d968e126234177c0cdeea550139be850c77e7212bea58159109a35c891a31bfdfaeb905f29a43f105743e030ede2efc25af4
+  metadata.gz: 1787df0d30deb90919492d1830f9525b5e5be9cd203e22731b60e6a852d1a1a15e8ae74ac930d247e427d1d1732f074a2a28c83a2c351aaa83c1b626f3169d1f
+  data.tar.gz: 521ea75c81d29f38b207496a18d42ead1302dcd28b5b995efafb634804705519cbb55b59c55f451564c18d03dbd5e5477037566bbf64e1e0626821d568857ad0

data/.gitignore

@@ -14,3 +14,4 @@ LATEST
 .gem-manifest
 .tgz-manifest
 /doc
+/lib/olddoc/version.rb

data/.olddoc.yml

@@ -8,3 +8,4 @@ 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

data/Documentation/olddoc.5.txt

@@ -28,6 +28,11 @@ at `ml_url`
 As of olddoc 1.2.0, `ml_url` and `nntp_url` may be YAML arrays
 with multiple URLs.
 
+As of olddoc 1.3.0, the `source_code` array may be any number of
+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
 
 olddoc(1)

data/GIT-VERSION-GEN

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# Copyright (C) 2016 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.3.0"
+vn = DEF_VER.dup
+
+# First see if there is a version file (included in release tarballs),
+# then try git-describe, then default.
+if File.exist?(".git")
+  describe = `git describe --abbrev=4 HEAD 2>/dev/null`.strip
+  case describe
+  when /\Av[0-9]*/
+    vn = describe
+    system(*%w(git update-index -q --refresh))
+    unless `git diff-index --name-only HEAD --`.chomp.empty?
+      vn << "-dirty"
+    end
+    vn.tr!('-', '.')
+  end
+end
+
+vn = vn.sub!(/\Av/, "")
+new_ruby_version = "#{CONSTANT} = '#{vn}'.freeze # :nodoc:\n"
+cur_ruby_version = File.read(RVF) rescue nil
+if new_ruby_version != cur_ruby_version
+  File.open(RVF, "w") { |fp| fp.write(new_ruby_version) }
+end
+File.chmod(0644, RVF)
+
+# generate the makefile snippet
+new_make_version = "VERSION = #{vn}\n"
+cur_make_version = File.read(GVF) rescue nil
+if new_make_version != cur_make_version
+  File.open(GVF, "w") { |fp| fp.write(new_make_version) }
+end
+File.chmod(0644, GVF)
+
+puts vn if $0 == __FILE__

data/GNUmakefile

@@ -3,7 +3,9 @@
 all::
 pkg = olddoc
 RUBY = ruby
-VERSION := $(shell $(RUBY) -Ilib -rolddoc -e 'puts Olddoc::VERSION')
+GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
+	@./GIT-VERSION-GEN
+-include GIT-VERSION-FILE
 
 check-warnings:
 	@(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \
@@ -46,7 +48,7 @@ doc: $(placeholders)
 gem: $(pkggem)
 
 install-gem: $(pkggem)
-	gem install $(CURDIR)/$<
+	gem install --local $(CURDIR)/$<
 
 $(pkggem): fix-perms .gem-manifest
 	VERSION=$(VERSION) gem build $(pkg).gemspec

data/lib/olddoc.rb

@@ -1,8 +1,6 @@
 # Copyright (C) 2015-2016 all contributors <olddoc-public@80x24.org>
 # License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 module Olddoc # :nodoc:
-  VERSION = '1.2.0' # :nodoc:
-
   autoload :Gemspec, 'olddoc/gemspec'
   autoload :History, 'olddoc/history'
   autoload :Merge, 'olddoc/merge'

data/lib/oldweb/_head.rhtml

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

data/lib/oldweb/_tail.rhtml

@@ -1,7 +1,8 @@
 <%
 public_email = @old_cfg['public_email']
 private_email = @old_cfg['private_email']
-archive_urls = Array(@old_cfg['ml_url']).concat(Array(@old_cfg['nntp_url']))
+source_code = Array(@old_cfg['source_code']).dup
+archive_urls = Array(@old_cfg['ml_url']) + Array(@old_cfg['nntp_url'])
 if url = archive_urls.shift %><hr /><pre>
 mail archives: <a
 href="<%= url %>"><%= url %></a><%
@@ -19,5 +20,10 @@ href="mailto:<%= public_email %>"><%= public_email %></a><%
 href="mailto:<%= private_email %>"><%= private_email %></a><%
     end
   end
+
+if url_or_cmd = source_code.shift
+%>
+source code: <%= url_or_cmd %>
+<% source_code.each do |x| %><%= "\t#{x}" %><% end
 end
-%></pre>
+%></pre><% end %>

data/lib/rdoc/discover.rb

@@ -1,6 +1,6 @@
 # :stopdoc:
 begin
-  gem 'rdoc', '~> 4.1'
+  gem 'rdoc', [ '>= 4.2', '< 6.0' ]
   require_relative '../olddoc'
 rescue Gem::LoadError
 end unless defined?(Olddoc)

data/olddoc.gemspec

@@ -2,6 +2,7 @@
 # License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 $LOAD_PATH << 'lib'
 require 'olddoc'
+require 'olddoc/version'
 extend Olddoc::Gemspec
 name, summary, title = readme_metadata
 Gem::Specification.new do |s|
@@ -14,8 +15,11 @@ Gem::Specification.new do |s|
   s.description = readme_description
   s.email = 'e@80x24.org'
   s.files = manifest
-  s.add_dependency('rdoc', '~> 4.2')
+
+  # works fine with RDoc 5.x
+  s.add_dependency('rdoc', ['>= 4.2', '< 6.0'])
   s.add_dependency('builder', '~> 3.2')
+  s.required_ruby_version = '>= 1.9.3'
   s.homepage = Olddoc.config['rdoc_url']
   s.licenses = 'GPL-3.0+'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: olddoc
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - olddoc hackers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-09 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -55,6 +61,7 @@ files:
 - Documentation/GNUmakefile
 - Documentation/olddoc.1.txt
 - Documentation/olddoc.5.txt
+- GIT-VERSION-GEN
 - GNUmakefile
 - INSTALL
 - NEWS
@@ -104,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -112,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: old-fashioned Ruby documentation generator