wrongdoc 1.0.0

data/lib/wrongdoc/rdoc.rb

@@ -0,0 +1,68 @@
+# we won't deal with the non-Darkfish RDoc in older rubies, it has frames :<
+if (!defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby") && \
+   RUBY_VERSION.to_f <= 1.8
+  require 'rubygems'
+  gem 'rdoc', '~> 3.0.1'
+end
+require 'rdoc/rdoc'
+
+class Wrongdoc::Rdoc
+  include Wrongdoc::RdocOptions
+  include Wrongdoc::ParseXML
+
+  def initialize(opts)
+    @rdoc_uri = URI.parse(opts[:rdoc_url])
+    @cgit_uri = URI.parse(opts[:cgit_url])
+  end
+
+  def run(argv = [])
+    rdoc(argv)
+    add_atom("doc/ChangeLog.html", cgit_atom_uri)
+    add_atom("doc/NEWS.html", news_atom_uri)
+    add_atom("doc/README.html", news_atom_uri)
+
+    # the stock RDoc index page layout lacks a vertical sidebar full of links
+    rdoc_index = "doc/rdoc_index.html"
+    File.exist?(rdoc_index) and File.unlink(rdoc_index)
+    File.rename("doc/index.html", rdoc_index)
+    File.link("doc/README.html", "doc/index.html")
+  end
+
+  def rdoc(argv)
+    r = RDoc::RDoc.new
+    r.document(rdoc_options.concat(argv))
+  end
+
+  def add_atom(path, atom_uri)
+    File.open(path, "a+") do |fp|
+      doc = parse_xml(fp.read)
+      doc.search("title").each { |t|
+        t.add_next_sibling(atom_node(doc, atom_uri))
+      }
+      fp.truncate 0
+      fp.write doc.to_xhtml
+    end
+  end
+
+  def cgit_atom_uri
+    uri = @cgit_uri.dup
+    uri.path += "/atom/"
+    uri.query = "h=master"
+    uri
+  end
+
+  def news_atom_uri
+    uri = @rdoc_uri.dup
+    uri.path += "NEWS.atom.xml"
+    uri
+  end
+
+  def atom_node(doc, uri, title = 'Atom feed')
+    link = Nokogiri::XML::Node.new('link', doc)
+    link['rel'] = 'alternate'
+    link['title'] = title
+    link['href'] = uri.to_s
+    link['type'] = 'application/atom+xml'
+    link
+  end
+end

data/lib/wrongdoc/rdoc_options.rb

@@ -0,0 +1,11 @@
+module Wrongdoc::RdocOptions
+  include Wrongdoc::Readme
+
+  def rdoc_options
+    webcvs = URI.parse(Wrongdoc.config[:cgit_url])
+    webcvs.path += "/tree"
+    webcvs = "#{webcvs}/%s"
+    _, _, title = readme_metadata
+    [ '-t', title, '-W', webcvs ]
+  end
+end

data/lib/wrongdoc/readme.rb

@@ -0,0 +1,20 @@
+# helpers for parsing the top-level README file (no suffix support :P)
+module Wrongdoc::Readme
+
+  # returns a one-paragraph summary from the README
+  def readme_description
+    File.read("README").split(/\n\n/)[1]
+  end
+
+  # parses the README file in the top-level directory for project metadata
+  def readme_metadata
+    l = File.readlines("README")[0].strip!
+    l.gsub!(/^=\s+/, '') or abort "#{l.inspect} doesn't start with '='"
+    title = l.dup
+    if l.gsub!(/^(\w+\!)\s+/, '') # Rainbows!
+      return $1, l, title
+    else
+      return (l.split(/\s*[:-]\s*/, 2)).push(title)
+    end
+  end
+end

data/lib/wrongdoc/release.rb

@@ -0,0 +1,44 @@
+module Wrongdoc::Release
+  self.extend Wrongdoc::History
+
+  def self.changes(io)
+    vtags = tags.map { |tag| tag[:tag] =~ /\Av/ and tag[:tag] }.sort
+    cmds = []
+    if vtags.empty?
+      cmds << %w(git log)
+    else
+      version = vtags[0]
+      prev = vtags[vtags.index(version) - 1]
+      if prev
+        cmds << [ 'git', 'diff', '--stat', prev, version ]
+        cmds << [ 'git', 'log', "#{prev}..#{version}" ]
+      else
+        cmds << [ 'git', 'log', version ]
+      end
+    end
+
+    io.sync = true
+    cmds.each_with_index do |cmd,i|
+      i > 0 and io.puts
+      pid, status = Process.waitpid2(fork do
+        $stdout.reopen(io)
+        io.close
+        exec *cmd
+      end)
+      status.success? or abort status.inspect
+    end
+  end
+
+  def self.notes(io, opts)
+    spec = Gem::Specification.load(Dir['*.gemspec'][0])
+    io.puts spec.description.strip
+    io.puts
+    io.puts "* #{spec.homepage}"
+    io.puts "* #{spec.email}"
+    io.puts "* #{opts[:git_url] || opts[:cgit_url]}"
+
+    _, _, body = `git cat-file tag v#{spec.version}`.split(/\n\n/, 3)
+    io.print "\nChanges:\n\n"
+    io.puts body
+  end
+end

data/lib/wrongdoc.rb

@@ -0,0 +1,35 @@
+require 'tempfile'
+require 'uri'
+require 'yaml'
+require 'tidy_ffi'
+require 'nokogiri'
+
+module Wrongdoc
+
+  # the version of wrongdoc, currently 1.0.0
+  VERSION = '1.0.0'
+
+  autoload :Readme, 'wrongdoc/readme'
+  autoload :History, 'wrongdoc/history'
+  autoload :Release, 'wrongdoc/release'
+
+  autoload :Changelog, 'wrongdoc/changelog'
+  autoload :NewsRdoc, 'wrongdoc/news_rdoc'
+  autoload :NewsAtom, 'wrongdoc/news_atom'
+  autoload :ParseXML, 'wrongdoc/parse_xml'
+
+  autoload :Prepare, 'wrongdoc/prepare'
+  autoload :Rdoc, 'wrongdoc/rdoc'
+  autoload :Merge, 'wrongdoc/merge'
+  autoload :Final, 'wrongdoc/final'
+
+  autoload :Gemspec, 'wrongdoc/gemspec'
+  autoload :RdocOptions, 'wrongdoc/rdoc_options'
+
+  def self.config(path = ".wrongdoc.yml")
+    File.exist?(path) or abort "#{path} not found in current directory"
+    opts = YAML.load(File.read(path))
+    opts.keys.each { |k| opts[k.to_sym] = opts.delete(k) } # symbolize keys
+    opts
+  end
+end

data/man/man1/wrongdoc.1

@@ -0,0 +1,19 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "WRONGDOC" "1" "December 2010" "" ""
+.
+.SH "NAME"
+\fBwrongdoc\fR \- removes JavaScript from RDoc
+.
+.SH "SYNOPSIS"
+\fBwrongdoc\fR prepare
+.
+.P
+\fBwrongdoc\fR
+.
+.SH "DESCRIPTION"
+\fBWrongdoc\fR does horrible things to your RDoc project\. It\'s own documentation sucks, but it\'ll help to make your documentation JavaScript\-free and therefore suck less :)
+.
+.SH "SEE ALSO"
+dotwrongdoc(5)

data/man/man5/dotwrongdoc.5

@@ -0,0 +1,22 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "DOTWRONGDOC" "5" "December 2010" "" ""
+.
+.SH "NAME"
+\fBdotwrongdoc\fR \- wrongdoc config file format
+.
+.SH "SYNOPSIS"
+A YAML file in the top\-level project directory named "\.wrongdoc\.yml"
+.
+.SH "DESCRIPTION"
+As wrongdoc favors consistency over configuration, there is minimal configuration to deal with\.
+.
+.SH "KEYS"
+\fBrdoc_url\fR, \fBcgit_url\fR should be obvious
+.
+.P
+\fBmerge_html\fR 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\.
+.
+.SH "SEE ALSO"
+wrongdoc(1)