olddoc 1.0.0

data/lib/oldweb/_sidebar_classes.rhtml

@@ -0,0 +1,27 @@
+<%
+@modsort.delete_if do |c|
+  c.full_name == "unknown" || @old_cfg["noindex"].include?(c.full_name)
+end
+unless @modsort.empty?
+  # To save space and reduce visual noise, we want to display:
+  #   Top Sub1 Sub2 Sub3
+  # Instead of
+  #   Top Top::Sub1 Top::Sub2 Top::Sub3
+  top_mod = nil
+  @modsort.each do |mod| %><%
+    parts = mod.full_name.split('::')
+    if parts[0] != top_mod && parts.size == 1
+      top_mod = parts[0]
+      %><%= '<br />' if mod != @modsort[0] %><%
+    elsif parts[0] != top_mod
+      top_mod = nil
+      %><%= '<br />' if mod != @modsort[0] %><%= parts[0] %> <%
+    else
+      parts.shift
+    end
+%><a
+href="<%= rel_prefix %><%= mod.path %>"><%= parts.join('::') %></a>
+<%
+  end
+end
+%><br />

data/lib/oldweb/_sidebar_extends.rhtml

@@ -0,0 +1,13 @@
+<%
+unless klass.extends.empty?
+%><p><b>Extended with:</b> <%
+  klass.each_extend do |ext|
+    unless String === ext.module
+%><a
+href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a><%
+    else
+%><%= ext.name %><%
+    end
+  end
+end
+%>

data/lib/oldweb/_sidebar_includes.rhtml

@@ -0,0 +1,12 @@
+<%
+unless klass.includes.empty?
+%><p><b>Included modules:</b> <%
+  klass.each_include do |inc|
+    unless String === inc.module %><a
+href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a><%
+    else %><%=
+      inc.name %><%
+    end
+  end
+end
+%>

data/lib/oldweb/_sidebar_installed.rhtml

@@ -0,0 +1,10 @@
+<h3>Documentation</h3><ul><%
+installed.each do |name, href, exists, type, _|
+  next if type == :extra %><li><%
+  if exists
+  %><a
+href="<%= href %>"><%= h name %></a><%
+  else
+  %><%= h name %><%
+  end
+end %></ul>

data/lib/oldweb/_sidebar_methods.rhtml

@@ -0,0 +1,6 @@
+<% unless klass.method_list.empty? %>
+<h3 id="method-list-section">Methods</h3><%
+klass.each_method do |meth| %>
+<a href="#<%= meth.aref %>"><%=
+meth.singleton ? '::' : '#' %><%= h meth.name %></a><%
+end %><% end %>

data/lib/oldweb/_sidebar_navigation.rhtml

@@ -0,0 +1,6 @@
+<br /><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>

data/lib/oldweb/_sidebar_pages.rhtml

@@ -0,0 +1,17 @@
+<%
+simple_files = @files.select(&:text?)
+unless simple_files.empty?
+  current_name = nil
+  if defined?(current) && current.respond_to?(:page_name)
+    current_name = current.page_name
+  end
+  simple_files.each do |f|
+    next if @old_cfg["noindex"].include?(f.page_name)
+    b = (current_name == f.page_name)
+%><a
+href="<%= rel_prefix %><%= f.path %>"><%=
+b ? '<b>' : '' %><%= h f.page_name %><%= b ? '</b>' : ''%></a>
+<%
+  end
+end
+%><br />

data/lib/oldweb/_sidebar_parent.rhtml

@@ -0,0 +1,13 @@
+<%
+# having Object as parent is boring
+if klass.type == 'class' && klass.superclass != 'Object'
+%><p><b>Parent:</b> <%
+  if klass.superclass and not String === klass.superclass
+%><a
+href="<%= klass.aref_to klass.superclass.path %>"><%=
+    klass.superclass.full_name %></a><%
+  else
+%><%= klass.superclass %><%
+  end
+end
+%>

data/lib/oldweb/_sidebar_sections.rhtml

@@ -0,0 +1,8 @@
+<%
+unless klass.sections.length == 1
+%><p><b>Sections:</b> <%
+  klass.sort_sections.each do |section| %><a
+href="#<%= section.aref %>"><%= h section.title %></a><%
+  end
+end
+%>

data/lib/oldweb/_sidebar_table_of_contents.rhtml

@@ -0,0 +1,15 @@
+<%
+comment = current.respond_to?(:comment_location) ? current.comment_location :
+          current.comment
+table = current.parse(comment).table_of_contents
+if table.length > 1
+%><%
+  table.each_with_index do |heading, i|
+    next if heading.level > @old_cfg['toc_max']
+%><a
+href="#<%= heading.label(current) %>"><%=
+    i == 0 ? "top" : heading.plain_html %></a>
+<%
+  end %><br /><%
+end
+%>

data/lib/oldweb/_tail.rhtml

@@ -0,0 +1,25 @@
+<%
+public_email = @old_cfg['public_email']
+private_email = @old_cfg['private_email']
+ml_url = @old_cfg['ml_url']
+git_doc = 'https://kernel.org/pub/software/scm/git/docs/'
+se_url = "#{git_doc}git-send-email.html"
+rp_url = "#{git_doc}git-request-pull.html"
+
+if public_email && private_email && ml_url %><hr /><p>
+We love to hear from you!<br />
+Email patches (using <a
+href="<%= se_url %>">git send-email</a>),
+pull requests (formatted using <a
+href="<%= rp_url %>">git request-pull</a>), questions, bug reports,
+suggestions, etc. to us publically at:<br /><a
+href="mailto:<%= public_email %>"><%= public_email %></a><br />
+Mail archives are available at: <a
+href="<%= ml_url %>"><%= ml_url %></a><br />
+Please send plain-text email only and do not waste bandwidth on HTML mail,
+HTML mail will not be read.<br />
+Quote as little as reasonable and do not <a
+href="http://catb.org/jargon/html/T/top-post.html">top post</a>.<br />
+For sensitive topics, email us privately at:
+<a
+href="mailto:<%= private_email %>"><%= private_email %></a><% end %>

data/lib/oldweb/class.rhtml

@@ -0,0 +1,79 @@
+<%=
+render('_sidebar_pages.rhtml') <<
+render('_sidebar_classes.rhtml') <<
+render('_sidebar_methods.rhtml')
+%><h1
+id="<%= h klass.aref %>"><%= klass.type %> <%= klass.full_name %></h1><%=
+klass.description.strip
+%><%
+nd = '(Not documented)'
+klass.each_section do |section, constants, attributes|
+  constants = constants.select(&:display?)
+  attributes = attributes.select(&:display?)
+  if section.title
+%><h2
+id="<%= section.aref %>"><%= section.title %></h2><%
+  end
+  if section.comment %><p><%= section.description.strip %></p><%
+  end
+  unless constants.empty? %><h3>Constants</h3><%
+    constants.each { |const|
+      %><h4
+id="<%= const.name %>"><%= const.name %></h4><%=
+      const.comment ? const.description.strip : nd %><%
+    } %><%
+  end
+  unless attributes.empty? %><h3>Attributes</h3><%
+    attributes.each do |attrib|
+%><h4
+id="<%= attrib.aref %>"><%=
+      h(attrib.name) %> [<%= attrib.rw %>]</h4><%=
+      attrib.comment ? attrib.description.strip : nd %><%
+    end
+  end
+  klass.methods_by_type(section).each do |type, visibilities|
+    next if visibilities.empty?
+    visibilities.each do |visibility, methods|
+      next if methods.empty? %><h3
+id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details">
+<%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3><%
+      methods.each do |method|
+      %><pre id="<%= method.aref %>"><b><%
+        if method.call_seq %><%= h method.call_seq %><%
+        else
+          %><%= h method.name %> <%= h method.param_seq %><%
+        end %></b><%= method_srclink(method) %></pre><%=
+          method.comment ? method.description.strip : nd %><%
+        if method.calls_super %>Calls superclass method<%=
+           method.superclass_method ?
+           method.formatter.link(method.superclass_method.full_name,
+                                 method.superclass_method.full_name) : nil
+        %><%
+        end
+        unless method.aliases.empty?
+        %> Also aliased as: <%=
+          method.aliases.map do |aka|
+            if aka.parent # HACK lib/rexml/encodings
+              %{<a href="#{klass.aref_to(aka.path)}">#{h aka.name}</a>}
+            else
+              h aka.name
+            end
+          end.join ", " %><%
+        end
+        if method.is_alias_for
+       %><br />Alias for:
+<a
+href="<%= klass.aref_to method.is_alias_for.path %>"><%=
+          h method.is_alias_for.name %></a><%
+        end
+      end
+    end
+  end
+end
+%><%=
+render('_sidebar_sections.rhtml').strip <<
+render('_sidebar_parent.rhtml').strip <<
+render('_sidebar_includes.rhtml').strip <<
+render('_sidebar_extends.rhtml').strip <<
+render('_sidebar_navigation.rhtml').strip
+%>

data/lib/oldweb/page.rhtml

@@ -0,0 +1,5 @@
+<%=
+render('_sidebar_pages.rhtml') <<
+render('_sidebar_classes.rhtml') <<
+file.description.strip
+%>

data/lib/oldweb/servlet_not_found.rhtml

@@ -0,0 +1,5 @@
+<%=
+  render('_sidebar_navigation.rhtml') <<
+  render('_sidebar_pages.rhtml') <<
+  render('_sidebar_classes.rhtml')
+%><h1>Not Found</h1><%= message %>

data/lib/oldweb/servlet_root.rhtml

@@ -0,0 +1,39 @@
+<h2><a href="<%= rel_prefix %>">Home</a></h2><%=
+render '_sidebar_installed.rhtml'
+%><h1>Local RDoc Documentation</h1>
+<p>Here you can browse local documentation from the ruby standard library and
+  your installed gems.
+<% extra_dirs = installed.select { |_, _, _, type,| type == :extra } %>
+<% unless extra_dirs.empty? %>
+<h2>Extra Documentation Directories</h2>
+  <p>The following additional documentation directories are available:</p>
+  <ol>
+  <% extra_dirs.each do |name, href, exists, _, path| %>
+    <li>
+    <% if exists %>
+      <a href="<%= href %>"><%= h name %></a> (<%= h path %>)
+    <% else %>
+      <%= h name %> (<%= h path %>; not available)
+    <% end %>
+  <% end %>
+  </ol>
+<% end %>
+<%
+gems = installed.select { |_, _, _, type,| type == :gem }
+missing = gems.reject { |_, _, exists,| exists }
+unless missing.empty? %>
+<h2>Missing Gem Documentation</h2>
+<p>You are missing documentation for some of your installed gems.
+You can install missing documentation for gems by running
+<kbd>gem rdoc --all</kbd>.  After installing the missing documentation you
+only need to reload this page.  The newly created documentation will
+automatically appear.
+<p>You can also install documentation for a specific gem by running one of
+the following commands.
+<ul>
+<% names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq %>
+<% names.each do |name| %>
+  <li><kbd>gem rdoc <%=h name %></kbd>
+<% end %>
+</ul>
+<% end %>

data/lib/oldweb/table_of_contents.rhtml

@@ -0,0 +1,52 @@
+<h1><%= h @title %></h1><%
+simple_files = @files.select(&:text?)
+unless simple_files.empty?
+%><h2 id="pages">Pages</h2>
+<ul><%
+  simple_files.sort.each do |file| %><li><a
+href="<%= file.path %>"><%= h file.page_name %></a>
+<%
+    # HACK table_of_contents should not exist on Document
+    table = file.parse(file.comment).table_of_contents
+    unless table.empty?
+%><ul><%
+      table.each do |heading|
+      %><li><a
+href="<%= file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a>
+<%    end
+%></ul><%
+    end
+%><%
+  end
+%></ul><%
+end
+%><h2
+id="classes">Classes and Modules</h2><ul><%
+@modsort.each do |klass| %><li
+class="<%= klass.type %>"><a
+href="<%= klass.path %>"><%= klass.full_name %></a>
+<%
+  table = []
+  table.concat klass.parse(klass.comment_location).table_of_contents
+  table.concat klass.section_contents
+
+  unless table.empty?
+    %><ul><%
+    table.each do |item|
+    %><li><a
+href="<%= klass.path %>#<%= item.aref %>"><%= item.plain_html %></a>
+<%
+    end %></ul><%
+  end
+%><%
+end
+%></ul><h2
+id="methods">Methods</h2><ul><%
+  @store.all_classes_and_modules.map do |mod|
+    mod.method_list
+  end.flatten.sort.each do |method|
+%><li><a
+href="<%= method.path %>"><%= h method.pretty_name %></a>
+- <%= method.parent.full_name %><%
+end
+%></ul>

data/lib/rdoc/discover.rb

@@ -0,0 +1,5 @@
+begin
+  gem 'rdoc', '~> 4.1'
+  require_relative '../olddoc'
+rescue Gem::LoadError
+end unless defined?(Olddoc)

data/olddoc.gemspec

@@ -0,0 +1,21 @@
+# Copyright (C) 2015, all contributors <olddoc-public@80x24.org>
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+$LOAD_PATH << 'lib'
+require 'olddoc'
+extend Olddoc::Gemspec
+name, summary, title = readme_metadata
+Gem::Specification.new do |s|
+  manifest = File.read('.gem-manifest').split(/\n/)
+  s.name = 'olddoc'
+  s.version = Olddoc::VERSION
+  s.executables = %w(olddoc)
+  s.authors = ["#{s.name} hackers"]
+  s.summary = summary
+  s.description = readme_description
+  s.email = Olddoc.config['private_email']
+  s.files = manifest
+  s.add_dependency('rdoc', '~> 4.2')
+  s.add_dependency('builder', '~> 3.2')
+  s.homepage = Olddoc.config['rdoc_url']
+  s.licenses = 'GPLv3+'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: olddoc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- olddoc hackers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-09 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |-
+  olddoc contains old-fashioned document generators for those who do not
+  wish to impose bloated, new-fangled web cruft on their readers.
+email: olddoc@80x24.org
+executables:
+- olddoc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".olddoc.yml"
+- COPYING
+- Documentation/.gitignore
+- Documentation/GNUmakefile
+- Documentation/olddoc.1.txt
+- Documentation/olddoc.5.txt
+- GNUmakefile
+- INSTALL
+- NEWS
+- README
+- Rakefile
+- TODO
+- bin/olddoc
+- lib/olddoc.rb
+- lib/olddoc/gemspec.rb
+- lib/olddoc/history.rb
+- lib/olddoc/merge.rb
+- lib/olddoc/news_atom.rb
+- lib/olddoc/news_rdoc.rb
+- lib/olddoc/prepare.rb
+- lib/olddoc/readme.rb
+- lib/oldweb.rb
+- lib/oldweb/_head.rhtml
+- lib/oldweb/_sidebar_classes.rhtml
+- lib/oldweb/_sidebar_extends.rhtml
+- lib/oldweb/_sidebar_includes.rhtml
+- lib/oldweb/_sidebar_installed.rhtml
+- lib/oldweb/_sidebar_methods.rhtml
+- lib/oldweb/_sidebar_navigation.rhtml
+- lib/oldweb/_sidebar_pages.rhtml
+- lib/oldweb/_sidebar_parent.rhtml
+- lib/oldweb/_sidebar_sections.rhtml
+- lib/oldweb/_sidebar_table_of_contents.rhtml
+- lib/oldweb/_tail.rhtml
+- lib/oldweb/class.rhtml
+- lib/oldweb/page.rhtml
+- lib/oldweb/servlet_not_found.rhtml
+- lib/oldweb/servlet_root.rhtml
+- lib/oldweb/table_of_contents.rhtml
+- lib/rdoc/discover.rb
+- man/olddoc.1
+- man/olddoc.5
+- olddoc.gemspec
+homepage: http://80x24.org/olddoc/
+licenses:
+- GPLv3+
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: old-fashioned Ruby documentation generator
+test_files: []