wrongdoc 1.5.0 → 1.6.0

data/.wrongdoc.yml

@@ -5,3 +5,5 @@ rdoc_url: http://bogomips.org/wrongdoc/
 merge_html:
   wrongdoc_1: Documentation/wrongdoc.1.html_fragment
   dotwrongdoc_5: Documentation/dotwrongdoc.5.html_fragment
+public_email: wrongdoc@librelist.org
+private_email: wrongdoc@bogomips.org

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v1.5.0.GIT
+DEF_VER=v1.6.0.GIT
 
 LF='
 '

data/README

@@ -15,7 +15,7 @@ on git history and tags.
 First, prepare a .wrongdoc.yml in the top-level directory of your project,
 then run the following command to generate your RDoc:
 
-    $ wrongdoc
+    $ wrongdoc all
 
 == Future Plans
 

data/bin/wrongdoc

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
-usage = "Usage: #{File.basename($0)} [prepare]"
+tasks = %w(prepare release_notes release_changes all)
+usage = "Usage: #{File.basename($0)} [#{tasks.join('|')}]"
 $stderr.sync = $stdout.sync = true
 require 'wrongdoc'
 opts = Wrongdoc.config
@@ -16,5 +17,6 @@ when "all"
   Wrongdoc::Merge.new(opts).run
   Wrongdoc::Final.new(opts, ARGV[1]).run
 else
-  abort "#{$0.inspect} #{ARGV.inspect} not understood"
+  warn "#{$0.inspect} #{ARGV.inspect} not understood"
+  abort usage
 end

data/lib/wrongdoc/final.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 class Wrongdoc::Final
   include Wrongdoc::ParseXML
   include Wrongdoc::NewsAtom
+  SE_URL = 'http://kernel.org/pub/software/scm/git/docs/git-send-email.html'
 
   def run
     Find.find('doc') { |path| /\.html\z/ =~ path and fix(path) }
@@ -14,6 +15,8 @@ class Wrongdoc::Final
   def initialize(opts, git_tag = nil)
     @cgit_uri = URI.parse(opts[:cgit_url])
     @rdoc_uri = URI.parse(opts[:rdoc_url])
+    @public_email = opts[:public_email] or warn ":public_email unset"
+    @private_email = opts[:private_email] or warn ":private_email unset"
     @git_tag = git_tag
   end
 
@@ -74,7 +77,7 @@ class Wrongdoc::Final
     doc.search('div#validator-badges p small').each { |x|
       if /\AGenerated/ =~ x.content
         first = x.children.first
-        first.content = first.content.gsub /\AG/, "Originally g"
+        first.content = first.content.gsub(/\AG/, "Originally g")
         last = x.children.last
         last.content = "#{last.content}, modified by "
 
@@ -82,6 +85,49 @@ class Wrongdoc::Final
         a["href"] = "http://bogomips.org/wrongdoc/"
         a.content = "wrongdoc"
         last.add_next_sibling(a)
+
+        @public_email && @private_email or return
+        txt = <<-EOF
+        We love to hear from you!<br />
+        Email patches (with <a href="#{SE_URL}">git send-email</a>),
+        pull requests, questions, bug reports, suggestions, etc.
+        to us publically at
+        <a href="mailto:#@public_email">#@public_email</a>.<br />
+        EOF
+
+        case @public_email
+        when /@librelist\.(?:com|org)\z/
+          txt << <<-EOF
+          To subscribe, just send any email to
+          <a href="mailto:#@public_email">#@public_email</a>,
+          and respond to the automated confirmation message.
+          EOF
+        when /\A(.+)@(rubyforge\.org)\z/ # Mailman
+          requests = "#$1-request@#$2"
+          txt << <<-EOF
+          No subscription to the mailing list is necessary,
+          just let us know to <b>Cc:</b> you if you're unsubscribed.<br />
+          To subscribe, email
+          <a href="mailto:#{requests}?subject=subscribe">#{requests}</a>
+          with \"subscribe\" in the Subject
+          and respond to the automated confirmation message.
+          EOF
+        end
+
+        txt << <<-EOF
+        <br />
+        <b>
+        Do not waste bandwidth with HTML, HTML mail will not be read.<br />
+        Quote only parts you're responding to and do not
+        <a href="http://catb.org/jargon/html/T/top-post.html">top post</a>.
+        <br />
+        </b>
+        For sensitive topics, email us privately at
+        <a href="mailto:#@private_email">#@private_email</a>.
+        EOF
+        para = Nokogiri::XML.fragment(txt)
+
+        last.parent.parent.add_next_sibling(para)
       end
     }
   end

data/lib/wrongdoc/news_atom.rb

@@ -4,7 +4,7 @@ module Wrongdoc::NewsAtom
 
   # generates an Atom feed based on git tags in the document directory
   def news_atom
-    project_name, short_desc, _ = x = readme_metadata
+    project_name, short_desc, _ = readme_metadata
     new_tags = tags[0,10]
     atom_uri = @rdoc_uri.dup
     atom_uri.path += "NEWS.atom.xml"

data/lib/wrongdoc/release.rb

@@ -20,12 +20,12 @@ module Wrongdoc::Release
     io.sync = true
     cmds.each_with_index do |cmd,i|
       i > 0 and io.puts
-      pid, status = Process.waitpid2(fork do
+      _, status = Process.waitpid2(fork do
         if io.fileno != $stdout.fileno
           $stdout.reopen(io)
           io.close
         end
-        exec *cmd
+        exec(*cmd)
       end)
       status.success? or abort status.inspect
     end
@@ -41,6 +41,7 @@ module Wrongdoc::Release
     io.puts "* #{spec.homepage}"
     io.puts "* #{spec.email}"
     io.puts "* #{opts[:git_url] || opts[:cgit_url]}"
+    io.puts "* #{spec.homepage}NEWS.atom.xml"
 
     io.print "\nChanges:\n\n"
     io.puts body

data/pkg.mk

@@ -7,7 +7,7 @@ GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
 	@./GIT-VERSION-GEN
 -include GIT-VERSION-FILE
 -include local.mk
-DLEXT := $(shell $(RUBY) -rrbconfig -e 'puts Config::CONFIG["DLEXT"]')
+DLEXT := $(shell $(RUBY) -rrbconfig -e 'puts RbConfig::CONFIG["DLEXT"]')
 RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION')
 RUBY_ENGINE := $(shell $(RUBY) -e 'puts((RUBY_ENGINE rescue "ruby"))')
 lib := lib
@@ -44,29 +44,32 @@ $(ext_dl): $(ext_src) $(ext_pfx_src) $(ext_pfx)/$(ext)/Makefile
 	$(MAKE) -C $(@D)
 lib := $(lib):$(ext_pfx)/$(ext)
 build: $(ext_dl)
+else
+build:
 endif
 
-pkg_extra := GIT-VERSION-FILE NEWS ChangeLog LATEST
+pkg_extra += GIT-VERSION-FILE NEWS ChangeLog LATEST
 ChangeLog: GIT-VERSION-FILE .wrongdoc.yml
 	$(WRONGDOC) prepare
+NEWS LATEST: ChangeLog
 
 manifest:
 	$(RM) .manifest
 	$(MAKE) .manifest
 
-.manifest: ChangeLog
+.manifest: $(pkg_extra)
 	(git ls-files && for i in $@ $(pkg_extra); do echo $$i; done) | \
 		LC_ALL=C sort > $@+
 	cmp $@+ $@ || mv $@+ $@
 	$(RM) $@+
 
-doc:: .document .wrongdoc.yml
-	find lib -type f -name '*.rbc' -exec rm -f '{}' ';'
+doc:: .document .wrongdoc.yml $(pkg_extra)
+	-find lib -type f -name '*.rbc' -exec rm -f '{}' ';'
 	-find ext -type f -name '*.rbc' -exec rm -f '{}' ';'
 	$(RM) -r doc
 	$(WRONGDOC) all
 	install -m644 COPYING doc/COPYING
-	install -m644 $(shell grep '^[A-Z]' .document) doc/
+	install -m644 $(shell LC_ALL=C grep '^[A-Z]' .document) doc/
 
 ifneq ($(VERSION),)
 pkggem := pkg/$(rfpackage)-$(VERSION).gem
@@ -144,7 +147,7 @@ test_units := $(wildcard test/test_*.rb)
 test: test-unit
 test-unit: $(test_units)
 $(test_units): build
-	$(RUBY) -I $(lib) $@
+	$(RUBY) -I $(lib) $@ $(RUBY_TEST_OPTS)
 
 # this requires GNU coreutils variants
 ifneq ($(RSYNC_DEST),)
@@ -164,5 +167,9 @@ doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.\(gif\|jpg\|png\|gz\)$$')
 doc_gz:
 	for i in $(docs); do \
 	  gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
+check-warnings:
+	@(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \
+	  do $(RUBY) -d -W2 -c $$i; done) | grep -v '^Syntax OK$$' || :
 
 .PHONY: all .FORCE-GIT-VERSION-FILE doc test $(test_units) manifest
+.PHONY: check-warnings

data/wrongdoc.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = rdoc_options
   s.require_paths = %w(lib)
   s.rubyforge_project = %q{rainbows}
-  s.add_dependency(%q<nokogiri>, ['~> 1.4'])
+  s.add_dependency(%q<nokogiri>, ['~> 1.5'])
   s.add_dependency(%q<tidy_ffi>, ['~> 0.1.3'])
-  s.add_dependency(%q<rdoc>, ['~> 3.5'])
+  s.add_dependency(%q<rdoc>, ['~> 3.9'])
 end

data/wrongdoc.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+# self-hosting version used for development
+set -e
+prefix="$(git rev-parse --show-toplevel)"
+exec ruby -I $prefix/lib $prefix/bin/wrongdoc "$@"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wrongdoc
 version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 1
-  - 5
+  - 6
   - 0
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors: 
 - wrongdoc hackers
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-30 00:00:00 +00:00
-default_executable: 
+date: 2011-08-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -26,11 +25,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 5
         segments: 
         - 1
-        - 4
-        version: "1.4"
+        - 5
+        version: "1.5"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -57,11 +56,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 21
         segments: 
         - 3
-        - 5
-        version: "3.5"
+        - 9
+        version: "3.9"
   type: :runtime
   version_requirements: *id003
 description: |-
@@ -136,8 +135,8 @@ files:
 - pkg.mk
 - setup.rb
 - wrongdoc.gemspec
+- wrongdoc.sh
 - wrongdoc_1
-has_rdoc: true
 homepage: http://bogomips.org/wrongdoc/
 licenses: []
 
@@ -170,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rainbows
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: RDoc done right (IMNSHO)