update packaging to use pkg.mk + wrongdoc
authorEric Wong <normalperson@yhbt.net>
Sun, 1 Jul 2012 08:11:16 +0000 (1 08:11 +0000)
committerEric Wong <normalperson@yhbt.net>
Sun, 1 Jul 2012 08:11:16 +0000 (1 08:11 +0000)
No more JavaScript on the homepage!

.gitignore
.wrongdoc.yml [new file with mode: 0644]
GNUmakefile
Rakefile
local-openid.gemspec
pkg.mk [new file with mode: 0644]

index 5b6817b..724cc90 100644 (file)
@@ -12,3 +12,4 @@ pkg/
 /man
 tags
 TAGS
+/LATEST
diff --git a/.wrongdoc.yml b/.wrongdoc.yml
new file mode 100644 (file)
index 0000000..f11e747
--- /dev/null
@@ -0,0 +1,6 @@
+---
+cgit_url: http://bogomips.org/local-openid.git
+git_url: git://bogomips.org/local-openid.git
+rdoc_url: http://bogomips.org/local-openid/
+public_email: local-openid@librelist.org
+private_email: normalperson@yhbt.net
dissimilarity index 98%
index 8d61275..2928059 100644 (file)
-all::
-RUBY = ruby
-RAKE = rake
-RSYNC = rsync
-GIT_URL = git://bogomips.org/local-openid.git
-
-GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
-       @./GIT-VERSION-GEN
--include GIT-VERSION-FILE
-
-pkg_extra := GIT-VERSION-FILE NEWS ChangeLog
-manifest: $(pkg_extra)
-       $(RM) .manifest
-       $(MAKE) .manifest
-
-.manifest:
-       (git ls-files && \
-         for i in $@ $(pkg_extra) $(man1_paths); \
-        do echo $$i; done) | LC_ALL=C sort > $@+
-       cmp $@+ $@ || mv $@+ $@
-       $(RM) $@+
-
-NEWS: GIT-VERSION-FILE
-       $(RAKE) -s news_rdoc > $@+
-       mv $@+ $@
-
-SINCE = 0.1.0
-ChangeLog: LOG_VERSION = \
-  $(shell git rev-parse -q "$(GIT_VERSION)" >/dev/null 2>&1 && \
-          echo $(GIT_VERSION) || git describe)
-ifneq ($(SINCE),)
-ChangeLog: log_range = v$(SINCE)..$(LOG_VERSION)
-endif
-ChangeLog: GIT-VERSION-FILE
-       @echo "ChangeLog from $(GIT_URL) ($(log_range))" > $@+
-       @echo >> $@+
-       git log $(log_range) | sed -e 's/^/    /' >> $@+
-       mv $@+ $@
-
-news_atom := http://bogomips.org/local-openid/NEWS.atom.xml
-cgit_atom := http://bogomips.org/local-openid.git/atom/?h=master
-atom = <link rel="alternate" title="Atom feed" href="$(1)" \
-             type="application/atom+xml"/>
-
-doc: .document NEWS ChangeLog
-       find bin lib -type f -name '*.rbc' -exec rm -f '{}' ';'
-       rdoc -a -t "$(shell sed -ne '1s/^= //p' README)"
-       install -m644 COPYING doc/COPYING
-       install -m644 $(shell grep '^[A-Z]' .document)  doc/
-       $(RUBY) -i -p -e \
-         '$$_.gsub!("</title>",%q{\&$(call atom,$(cgit_atom))})' \
-         doc/ChangeLog.html
-       $(RUBY) -i -p -e \
-         '$$_.gsub!("</title>",%q{\&$(call atom,$(news_atom))})' \
-         doc/NEWS.html doc/README.html
-       $(RAKE) -s news_atom > doc/NEWS.atom.xml
-       cd doc && ln README.html tmp && mv tmp index.html
-
-publish_doc:
-       -git set-file-times
-       $(RM) -r doc ChangeLog NEWS
-       $(MAKE) doc LOG_VERSION=$(shell git tag -l | tail -1)
-       @awk 'BEGIN{RS="=== ";ORS=""}NR==2{sub(/\n$$/,"");print RS""$$0 }' \
-        < NEWS > doc/LATEST
-       find doc/images doc/js -type f | \
-               TZ=UTC xargs touch -d '1970-01-01 00:00:00' doc/rdoc.css
-       $(MAKE) doc_gz
-       chmod 644 $$(find doc -type f)
-       $(RSYNC) -av --delete doc/ bogomips.org:/srv/bogomips/local-openid/
-       git ls-files | xargs touch
-
-ifneq ($(VERSION),)
-rfproject := qrp
-rfpackage := local-openid
-pkggem := pkg/$(rfpackage)-$(VERSION).gem
-pkgtgz := pkg/$(rfpackage)-$(VERSION).tgz
-release_notes := release_notes-$(VERSION)
-release_changes := release_changes-$(VERSION)
-
-release-notes: $(release_notes)
-release-changes: $(release_changes)
-$(release_changes):
-       $(RAKE) -s release_changes > $@+
-       $(VISUAL) $@+ && test -s $@+ && mv $@+ $@
-$(release_notes):
-       GIT_URL=$(GIT_URL) $(RAKE) -s release_notes > $@+
-       $(VISUAL) $@+ && test -s $@+ && mv $@+ $@
-
-# ensures we're actually on the tagged $(VERSION), only used for release
-verify:
-       test x"$(shell umask)" = x0022
-       git rev-parse --verify refs/tags/v$(VERSION)^{}
-       git diff-index --quiet HEAD^0
-       test `git rev-parse --verify HEAD^0` = \
-            `git rev-parse --verify refs/tags/v$(VERSION)^{}`
-
-fix-perms:
-       -git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644
-       -git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755
-
-gem: $(pkggem)
-
-install-gem: $(pkggem)
-       gem install $(CURDIR)/$<
-
-$(pkggem): manifest fix-perms
-       gem build $(rfpackage).gemspec
-       mkdir -p pkg
-       mv $(@F) $@
-
-$(pkgtgz): distdir = $(basename $@)
-$(pkgtgz): HEAD = v$(VERSION)
-$(pkgtgz): manifest fix-perms
-       @test -n "$(distdir)"
-       $(RM) -r $(distdir)
-       mkdir -p $(distdir)
-       tar cf - `cat .manifest` | (cd $(distdir) && tar xf -)
-       cd pkg && tar c $(basename $(@F)) | gzip -9 > $(@F)+
-       mv $@+ $@
-
-package: $(pkgtgz) $(pkggem)
-
-test-release: verify package $(release_notes) $(release_changes)
-release: verify package $(release_notes) $(release_changes)
-       # make tgz release on RubyForge
-       rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
-         $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
-       # push gem to Gemcutter
-       gem push $(pkggem)
-       # in case of gem downloads from RubyForge releases page
-       -rubyforge add_file \
-         $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
-else
-gem install-gem: GIT-VERSION-FILE
-       $(MAKE) $@ VERSION=$(GIT_VERSION)
-endif
-
-# Create gzip variants of the same timestamp as the original so nginx
-# "gzip_static on" can serve the gzipped versions directly.
-doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.\(gif\|jpg\|png\|gz\)$$')
-doc_gz:
-       touch doc/NEWS.atom.xml -d "$$(awk 'NR==1{print $$4,$$5,$$6}' NEWS)"
-       for i in $(docs); do \
-         gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
-.PHONY: .FORCE-GIT-VERSION-FILE doc manifest
+all::
+RSYNC_DEST := bogomips.org:/srv/bogomips/local-openid
+rfproject := qrp
+rfpackage := local-openid
+include pkg.mk
+ifneq ($(VERSION),)
+release::
+       $(RAKE) raa_update VERSION=$(VERSION)
+       $(RAKE) publish_news VERSION=$(VERSION)
+endif
index 1bd1474..27ba42f 100644 (file)
--- a/Rakefile
+++ b/Rakefile
 # -*- encoding: binary -*-
-autoload :Gem, 'rubygems'
+require 'wrongdoc'
+cgit_url = Wrongdoc.config[:cgit_url]
+git_url = Wrongdoc.config[:git_url]
 
-def tags
-  timefmt = '%Y-%m-%dT%H:%M:%SZ'
-  @tags ||= `git tag -l`.split(/\n/).map do |tag|
-    if %r{\Av[\d\.]+\z} =~ tag
-      header, subject, body = `git cat-file tag #{tag}`.split(/\n\n/, 3)
-      header = header.split(/\n/)
-      tagger = header.grep(/\Atagger /).first
-      body ||= "initial"
-      {
-        :time => Time.at(tagger.split(/ /)[-2].to_i).utc.strftime(timefmt),
-        :tagger_name => %r{^tagger ([^<]+)}.match(tagger)[1].strip,
-        :tagger_email => %r{<([^>]+)>}.match(tagger)[1].strip,
-        :id => `git rev-parse refs/tags/#{tag}`.chomp!,
-        :tag => tag,
-        :subject => subject,
-        :body => body,
-      }
-    end
-  end.compact.sort { |a,b| b[:time] <=> a[:time] }
-end
-
-cgit_url = "http://bogomips.org/local-openid.git"
-git_url = ENV['GIT_URL'] || 'git://bogomips.org/local-openid.git'
-
-desc 'prints news as an Atom feed'
-task :news_atom do
-  require 'nokogiri'
-  new_tags = tags[0,10]
-  puts(Nokogiri::XML::Builder.new do
-    feed :xmlns => "http://www.w3.org/2005/Atom" do
-      id! "http://bogomips.org/local-openid/NEWS.atom.xml"
-      title "local-openid news"
-      subtitle %q{Single User, Ephemeral OpenID Provider}
-      link! :rel => 'alternate', :type => 'text/html',
-            :href => 'http://bogomips.org/local-openid/NEWS.html'
-      updated(new_tags.empty? ? "1970-01-01T00:00:00Z" : new_tags.first[:time])
-      new_tags.each do |tag|
-        entry do
-          title tag[:subject]
-          updated tag[:time]
-          published tag[:time]
-          author {
-            name tag[:tagger_name]
-            email tag[:tagger_email]
-          }
-          url = "#{cgit_url}/tag/?id=#{tag[:tag]}"
-          link! :rel => "alternate", :type => "text/html", :href =>url
-          id! url
-          message_only = tag[:body].split(/\n.+\(\d+\):\n {6}/s).first.strip
-          content({:type =>:text}, message_only)
-          content(:type =>:xhtml) { pre tag[:body] }
-        end
-      end
-    end
-  end.to_xml)
-end
-
-desc 'prints RDoc-formatted news'
-task :news_rdoc do
-  tags.each do |tag|
-    time = tag[:time].tr!('T', ' ').gsub!(/:\d\dZ/, ' UTC')
-    puts "=== #{tag[:tag].sub(/^v/, '')} / #{time}"
-    puts ""
-
-    body = tag[:body]
-    puts tag[:body].gsub(/^/sm, "  ").gsub(/[ \t]+$/sm, "")
-    puts ""
-  end
-end
-
-desc "print release changelog for Rubyforge"
-task :release_changes do
-  version = ENV['VERSION'] or abort "VERSION= needed"
-  version = "v#{version}"
-  vtags = tags.map { |tag| tag[:tag] =~ /\Av/ and tag[:tag] }.sort
-  prev = vtags[vtags.index(version) - 1]
-  if prev
-    system('git', 'diff', '--stat', prev, version) or abort $?
-    puts ""
-    system('git', 'log', "#{prev}..#{version}") or abort $?
-  else
-    system('git', 'log', version) or abort $?
-  end
-end
-
-desc "print release notes for Rubyforge"
-task :release_notes do
-  spec = Gem::Specification.load('local-openid.gemspec')
-  puts spec.description.strip
-  puts ""
-  puts "* #{spec.homepage}"
-  puts "* #{spec.email}"
-  puts "* #{git_url}"
-
-  _, _, body = `git cat-file tag v#{spec.version}`.split(/\n\n/, 3)
-  print "\nChanges:\n\n"
-  puts body
-end
-
-desc "read news article from STDIN and post to rubyforge"
+desc "post news article to rubyforge"
 task :publish_news do
   require 'rubyforge'
-  IO.select([STDIN], nil, nil, 1) or abort "E: news must be read from stdin"
-  msg = STDIN.readlines
+  spec = Gem::Specification.load('local-openid.gemspec')
+  tmp = Tempfile.new('rf-news')
+  _, subject, body = `git cat-file tag v#{spec.version}`.split(/\n\n/, 3)
+  tmp.puts subject
+  tmp.puts
+  tmp.puts spec.description.strip
+  tmp.puts ""
+  tmp.puts "* #{spec.homepage}"
+  tmp.puts "* #{spec.email}"
+  tmp.puts "* #{git_url}"
+  tmp.print "\nChanges:\n\n"
+  tmp.puts body
+  tmp.flush
+  system(ENV["VISUAL"], tmp.path) or abort "#{ENV["VISUAL"]} failed: #$?"
+  msg = File.readlines(tmp.path)
   subject = msg.shift
   blank = msg.shift
   blank == "\n" or abort "no newline after subject!"
index c78a3b3..d1bb08e 100644 (file)
@@ -1,32 +1,24 @@
 ENV["VERSION"] or abort "VERSION= must be specified"
 manifest = File.readlines('.manifest').map! { |x| x.chomp! }
+require 'wrongdoc'
+extend Wrongdoc::Gemspec
+name, summary, title = readme_metadata
 
 Gem::Specification.new do |s|
   s.name = %q{local-openid}
-  s.version = ENV["VERSION"]
+  s.version = ENV["VERSION"].dup
 
   s.authors = ["Eric Wong"]
   s.date = Time.now.utc.strftime('%Y-%m-%d')
-  s.description = File.read("README").split(/\n\n/)[1]
-  s.email = %q{local.openid@librelist.com}
+  s.description = readme_description
+  s.email = %q{local.openid@librelist.org}
   s.executables = %w(local-openid)
 
-  s.extra_rdoc_files = File.readlines('.document').map! do |x|
-    x.chomp!
-    if File.directory?(x)
-      manifest.grep(%r{\A#{x}/})
-    elsif File.file?(x)
-      x
-    else
-      nil
-    end
-  end.flatten.compact
-
+  s.extra_rdoc_files = extra_rdoc_files(manifest)
   s.files = manifest
-  s.homepage = %q{http://bogomips.org/local-openid/}
-  s.summary = %q{Single User, Ephemeral OpenID Provider}
-  s.rdoc_options = [ "-a", "-t", "local-openid - #{s.summary}" ]
-  s.require_paths = %w(lib)
+  s.homepage = Wrongdoc.config[:rdoc_url]
+  s.summary = summary
+  s.rdoc_options = rdoc_options
   s.rubyforge_project = %q{qrp}
   s.add_dependency(%q<sinatra>, ["~> 1.0.0"])
   s.add_dependency(%q<ruby-openid>, ["~> 2.1.7"])
diff --git a/pkg.mk b/pkg.mk
new file mode 100644 (file)
index 0000000..4cd5bef
--- /dev/null
+++ b/pkg.mk
@@ -0,0 +1,175 @@
+RUBY = ruby
+RAKE = rake
+RSYNC = rsync
+WRONGDOC = wrongdoc
+
+GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
+       @./GIT-VERSION-GEN
+-include GIT-VERSION-FILE
+-include local.mk
+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
+
+ifeq ($(shell test -f script/isolate_for_tests && echo t),t)
+isolate_libs := tmp/isolate/$(RUBY_ENGINE)-$(RUBY_VERSION)/isolate.mk
+$(isolate_libs): script/isolate_for_tests
+       @$(RUBY) script/isolate_for_tests
+-include $(isolate_libs)
+lib := $(lib):$(ISOLATE_LIBS)
+endif
+
+ext := $(firstword $(wildcard ext/*))
+ifneq ($(ext),)
+ext_pfx := tmp/ext/$(RUBY_ENGINE)-$(RUBY_VERSION)
+ext_h := $(wildcard $(ext)/*/*.h $(ext)/*.h)
+ext_src := $(wildcard $(ext)/*.c $(ext_h))
+ext_pfx_src := $(addprefix $(ext_pfx)/,$(ext_src))
+ext_d := $(ext_pfx)/$(ext)/.d
+$(ext)/extconf.rb: $(wildcard $(ext)/*.h)
+       @>> $@
+$(ext_d):
+       @mkdir -p $(@D)
+       @> $@
+$(ext_pfx)/$(ext)/%: $(ext)/% $(ext_d)
+       install -m 644 $< $@
+$(ext_pfx)/$(ext)/Makefile: $(ext)/extconf.rb $(ext_d) $(ext_h)
+       $(RM) -f $(@D)/*.o
+       cd $(@D) && $(RUBY) $(CURDIR)/$(ext)/extconf.rb
+ext_sfx := _ext.$(DLEXT)
+ext_dl := $(ext_pfx)/$(ext)/$(notdir $(ext)_ext.$(DLEXT))
+$(ext_dl): $(ext_src) $(ext_pfx_src) $(ext_pfx)/$(ext)/Makefile
+       @echo $^ == $@
+       $(MAKE) -C $(@D)
+lib := $(lib):$(ext_pfx)/$(ext)
+build: $(ext_dl)
+else
+build:
+endif
+
+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: $(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 $(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 LC_ALL=C grep '^[A-Z]' .document) doc/
+
+ifneq ($(VERSION),)
+pkggem := pkg/$(rfpackage)-$(VERSION).gem
+pkgtgz := pkg/$(rfpackage)-$(VERSION).tgz
+release_notes := release_notes-$(VERSION)
+release_changes := release_changes-$(VERSION)
+
+release-notes: $(release_notes)
+release-changes: $(release_changes)
+$(release_changes):
+       $(WRONGDOC) release_changes > $@+
+       $(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+$(release_notes):
+       $(WRONGDOC) release_notes > $@+
+       $(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+
+# ensures we're actually on the tagged $(VERSION), only used for release
+verify:
+       test x"$(shell umask)" = x0022
+       git rev-parse --verify refs/tags/v$(VERSION)^{}
+       git diff-index --quiet HEAD^0
+       test $$(git rev-parse --verify HEAD^0) = \
+            $$(git rev-parse --verify refs/tags/v$(VERSION)^{})
+
+fix-perms:
+       -git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644
+       -git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755
+
+gem: $(pkggem)
+
+install-gem: $(pkggem)
+       gem install $(CURDIR)/$<
+
+$(pkggem): manifest fix-perms
+       gem build $(rfpackage).gemspec
+       mkdir -p pkg
+       mv $(@F) $@
+
+$(pkgtgz): distdir = $(basename $@)
+$(pkgtgz): HEAD = v$(VERSION)
+$(pkgtgz): manifest fix-perms
+       @test -n "$(distdir)"
+       $(RM) -r $(distdir)
+       mkdir -p $(distdir)
+       tar cf - $$(cat .manifest) | (cd $(distdir) && tar xf -)
+       cd pkg && tar cf - $(basename $(@F)) | gzip -9 > $(@F)+
+       mv $@+ $@
+
+package: $(pkgtgz) $(pkggem)
+
+test-release:: verify package $(release_notes) $(release_changes)
+       # make tgz release on RubyForge
+       @echo rubyforge add_release -f \
+         -n $(release_notes) -a $(release_changes) \
+         $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
+       @echo gem push $(pkggem)
+       @echo rubyforge add_file \
+         $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
+release:: verify package $(release_notes) $(release_changes)
+       # make tgz release on RubyForge
+       rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
+         $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
+       # push gem to RubyGems.org
+       gem push $(pkggem)
+       # in case of gem downloads from RubyForge releases page
+       rubyforge add_file \
+         $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
+else
+gem install-gem: GIT-VERSION-FILE
+       $(MAKE) $@ VERSION=$(GIT_VERSION)
+endif
+
+all:: test
+test_units := $(wildcard test/test_*.rb)
+test: test-unit
+test-unit: $(test_units)
+$(test_units): build
+       $(RUBY) -I $(lib) $@ $(RUBY_TEST_OPTS)
+
+# this requires GNU coreutils variants
+ifneq ($(RSYNC_DEST),)
+publish_doc:
+       -git set-file-times
+       $(MAKE) doc
+       find doc/images -type f | \
+               TZ=UTC xargs touch -d '1970-01-01 00:00:06' doc/rdoc.css
+       $(MAKE) doc_gz
+       $(RSYNC) -av doc/ $(RSYNC_DEST)/
+       git ls-files | xargs touch
+endif
+
+# Create gzip variants of the same timestamp as the original so nginx
+# "gzip_static on" can serve the gzipped versions directly.
+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