pg 0.9.0 → 0.10.0

data/rake/hg.rb

@@ -22,6 +22,8 @@ unless defined?( HG_DOTDIR )
 	### 
 
 	module MercurialHelpers
+		require './helpers.rb' unless defined?( RakefileHelpers )
+		include RakefileHelpers
 
 		###############
 		module_function
@@ -83,7 +85,7 @@ unless defined?( HG_DOTDIR )
 
 		### Return the list of files which are of status 'unknown'
 		def get_unknown_files
-			list = read_command_output( 'hg', 'status', '-un', '--no-color' )
+			list = read_command_output( 'hg', 'status', '-un', '--color', 'never' )
 			list = list.split( /\n/ )
 
 			trace "New files: %p" % [ list ]
@@ -213,13 +215,20 @@ unless defined?( HG_DOTDIR )
 			paths = get_repo_paths()
 			if origin_url = paths['default']
 				ask_for_confirmation( "Pull and update from '#{origin_url}'?", false ) do
-					run 'hg', 'pull', '-u'
+					Rake::Task['hg:pull_without_confirmation'].invoke
 				end
 			else
 				trace "Skipping pull: No 'default' path."
 			end
 		end
 
+
+		desc "Pull and update without confirmation"
+		task :pull_without_confirmation do
+			run 'hg', 'pull', '-u'
+		end
+
+
 		desc "Check the current code in if tests pass"
 		task :checkin => ['hg:pull', 'hg:newfiles', 'test', COMMIT_MSG_FILE] do
 			targets = get_target_args()
@@ -240,13 +249,18 @@ unless defined?( HG_DOTDIR )
 			paths = get_repo_paths()
 			if origin_url = paths['default']
 				ask_for_confirmation( "Push to '#{origin_url}'?", false ) do
-					run 'hg', 'push'
+					Rake::Task['hg:push_without_confirmation'].invoke
 				end
 			else
 				trace "Skipping push: No 'default' path."
 			end
 		end
 
+		desc "Push to the default repo without confirmation"
+		task :push_without_confirmation do
+			run 'hg', 'push'
+		end
+
 	end
 
 	if HG_DOTDIR.exist?

data/rake/manual.rb

@@ -147,9 +147,14 @@ module Manual
 
 			layout = self.config['layout'].sub( /\.page$/, '' )
 			templatepath = @layouts_dir + "#{layout}.page"
-			template = ERB.new( templatepath.read )
-			page = self
+			template = nil
+			if Object.const_defined?( :Encoding )
+				template = ERB.new( templatepath.read(:encoding => 'UTF-8') )
+			else
+				template = ERB.new( templatepath.read )
+			end
 
+			page = self
 			html = template.result( binding() )
 
 			# Use Tidy to clean up the html if 'cleanup' is turned on, but remove the Tidy
@@ -565,7 +570,7 @@ module Manual
 				manual_pages = setup_page_conversion_tasks( sourcedir, outputdir, catalog )
 
 				desc "Build the manual"
-				task :build => [ :rdoc, :copy_resources, :copy_apidocs, :generate_pages ]
+				task :build => [ :apidocs, :copy_resources, :copy_apidocs, :generate_pages ]
 
 				task :clobber do
 					RakeFileUtils.verbose( $verbose ) do
@@ -686,8 +691,8 @@ module Manual
 			end
 
 			desc "Copy API documentation to the manual output directory"
-			task :copy_apidocs => :rdoc do
-				cp_r( RDOCDIR, outputdir )
+			task :copy_apidocs => :apidocs do
+				cp_r( API_DOCSDIR, outputdir )
 			end
 
 			# Now group all the resource file tasks into a containing task
@@ -713,7 +718,7 @@ if MANUALDIR.exist?
 
 		Manual::GenTask.new do |manual|
 			manual.metadata.version = PKG_VERSION
-			manual.metadata.api_dir = RDOCDIR
+			manual.metadata.api_dir = API_DOCSDIR
 			manual.output_dir = MANUALOUTPUTDIR
 			manual.base_dir = MANUALDIR
 			manual.source_dir = 'src'

data/rake/packaging.rb

@@ -12,7 +12,13 @@ include Config
 ### Task: prerelease
 desc "Append the package build number to package versions"
 task :prerelease do
-	GEMSPEC.version.version += ".#{PKG_BUILD}"
+	GEMSPEC.version.version << "pre#{PKG_BUILD}"
+	Rake::Task[:gem].clear
+
+	Gem::PackageTask.new( GEMSPEC ) do |pkg|
+		pkg.need_zip = true
+		pkg.need_tar = true
+	end
 end
 
 

data/rake/publishing.rb

@@ -5,6 +5,8 @@
 RELEASE_NOTES_FILE    = 'release.notes'
 RELEASE_ANNOUNCE_FILE = 'release.ann'
 
+GEM_PUBHOST = '' unless defined?( GEM_PUBHOST )
+
 require 'net/smtp'
 require 'net/protocol'
 require 'openssl'
@@ -13,6 +15,7 @@ $publish_privately = false
 
 ### Add SSL to Net::SMTP
 class Net::SMTP
+
 	def ssl_start( helo='localhost.localdomain', user=nil, secret=nil, authtype=nil )
 		if block_given?
 			begin
@@ -93,6 +96,9 @@ begin
 	require 'etc'
 	require 'socket'
 	require 'text/format'
+	require 'rubygems/gemcutter_utilities'
+
+	include Gem::GemcutterUtilities
 
 	### Generate a valid RFC822 message-id
 	def gen_message_id
@@ -104,6 +110,48 @@ begin
 	end
 
 
+	### Fetch the rubygems API token if it hasn't been already.
+	def sign_in_to_rubygems
+		return if Gem.configuration.rubygems_api_key
+
+		log "Enter your RubyGems.org credentials."
+
+		email    = prompt "   Email: "
+		password = prompt_for_password( "Password: " )
+
+		response = rubygems_api_request( :get, "api/v1/api_key" ) do |request|
+			request.basic_auth( email, password )
+		end
+
+		with_response( response ) do |resp|
+			log "Signed in."
+			Gem.configuration.rubygems_api_key = resp.body
+		end
+	end
+
+
+	### Push the gem at the specified +path+ to the rubygems server at +gemhost+.
+	def push_gem( path, gemhost )
+		ENV['RUBYGEMS_HOST'] = "http://#{gemhost}"
+
+		sign_in_to_rubygems()
+
+		response = rubygems_api_request( :post, "api/v1/gems" ) do |request|
+			request.body = Gem.read_binary( path )
+			request.add_field "Content-Length", request.body.size
+			request.add_field "Content-Type",   "application/octet-stream"
+			request.add_field "Authorization",  Gem.configuration.rubygems_api_key
+		end
+
+		case response
+		when Net::HTTPSuccess
+			log( response.body )
+		else
+			fail( response.body )
+		end
+	end
+
+
 	namespace :release do
 		task :default => [ :prep_release, :upload, :publish, :announce ]
 
@@ -133,120 +181,138 @@ begin
 		end
 		CLOBBER.include( RELEASE_NOTES_FILE )
 
-
-		desc "Upload project documentation and packages to #{PROJECT_HOST}"
-		task :upload => [ :upload_docs, :upload_packages ]
-		task :project => :upload # the old name
-
-		desc "Publish the project docs to #{PROJECT_HOST}"
-		task :upload_docs => [ :rdoc ] do
-			when_writing( "Publishing docs to #{PROJECT_SCPDOCURL}" ) do
-				log "Uploading API documentation to %s:%s" % [ PROJECT_HOST, PROJECT_DOCDIR ]
-				run 'ssh', PROJECT_HOST, "rm -rf #{PROJECT_DOCDIR}"
-				run 'scp', '-qCr', RDOCDIR, PROJECT_SCPDOCURL
+		# Only define upload tasks if there's an upload host
+		if PROJECT_HOST.empty?
+			task :no_upload_host do
+				log "Skipping upload: no upload host."
+			end
+			task :upload => :no_upload_host
+			task :upload_docs => :no_upload_host
+			task :upload_packages => :no_upload_host
+		else
+			desc "Upload project documentation and packages to #{PROJECT_HOST}"
+			task :upload => [ :upload_docs, :upload_packages ]
+			task :project => :upload # the old name
+
+			desc "Publish the project docs to #{PROJECT_HOST}"
+			task :upload_docs => [ :apidocs ] do
+				when_writing( "Publishing docs to #{PROJECT_SCPDOCURL}" ) do
+					log "Uploading API documentation to %s:%s" % [ PROJECT_HOST, PROJECT_DOCDIR ]
+					run 'ssh', PROJECT_HOST, "rm -rf #{PROJECT_DOCDIR}"
+					run 'scp', '-qCr', API_DOCSDIR, PROJECT_SCPDOCURL
+				end
 			end
-		end
 
-		desc "Publish the project packages to #{PROJECT_HOST}"
-		task :upload_packages => [ :package ] do
-			when_writing( "Uploading packages") do
-				pkgs = Pathname.glob( PKGDIR + "#{PKG_FILE_NAME}.{gem,tar.gz,tar.bz2,zip}" )
-				log "Uploading %d packages to #{PROJECT_SCPPUBURL}" % [ pkgs.length ]
-				pkgs.each do |pkgfile|
-					run 'scp', '-qC', pkgfile, PROJECT_SCPPUBURL
-                end
-            end
+			desc "Publish the project packages to #{PROJECT_HOST}"
+			task :upload_packages => [ :package ] do
+				when_writing( "Uploading packages") do
+					pkgs = Pathname.glob( PKGDIR + "#{PKG_FILE_NAME}.{gem,tar.gz,tar.bz2,zip}" )
+					log "Uploading %d packages to #{PROJECT_SCPPUBURL}" % [ pkgs.length ]
+					pkgs.each do |pkgfile|
+						run 'scp', '-qC', pkgfile, PROJECT_SCPPUBURL
+	                end
+	            end
+			end
 		end
 
+		# Only define the announcement tasks if there are addresses to announce to
+		if RELEASE_ANNOUNCE_ADDRESSES.empty?
+			task :no_announce_addresses do
+				log "Skipping announcement: no announce addresses"
+			end
+			task :announce => :no_announce_addresses
 
-		file RELEASE_ANNOUNCE_FILE => [RELEASE_NOTES_FILE] do |task|
-			relnotes = File.read( RELEASE_NOTES_FILE )
-			announce_body = %{
-
-				Version #{PKG_VERSION} of #{PKG_NAME} has been released.
-
-				#{Text::Format.new(:first_indent => 0).format_one_paragraph(GEMSPEC.description)}
+		else
+			file RELEASE_ANNOUNCE_FILE => [RELEASE_NOTES_FILE] do |task|
+				relnotes = File.read( RELEASE_NOTES_FILE )
+				announce_body = %{
 
-				== Project Page
+					Version #{PKG_VERSION} of #{PKG_NAME} has been released.
 
-				  #{GEMSPEC.homepage}
+					#{Text::Format.new(:first_indent => 0).format_one_paragraph(GEMSPEC.description)}
 
-				== Installation
+					== Project Page
 
-				Via gems:
+					  #{GEMSPEC.homepage}
 
-				  $ sudo gem install #{GEMSPEC.name}
+					== Installation
 
-				or from source:
+					  $ sudo gem install #{GEMSPEC.name}
 
-				  $ wget http://deveiate.org/code/#{PKG_FILE_NAME}.tar.gz
-				  $ tar -xzvf #{PKG_FILE_NAME}.tar.gz
-				  $ cd #{PKG_FILE_NAME}
-				  $ sudo rake install
+					== Changes
+					#{relnotes}
+				}.gsub( /^\t+/, '' )
 
-				== Changes
-				#{relnotes}
-			}.gsub( /^\t+/, '' )
+				File.open( task.name, File::WRONLY|File::TRUNC|File::CREAT ) do |fh|
+					fh.print( announce_body )
+				end
 
-			File.open( task.name, File::WRONLY|File::TRUNC|File::CREAT ) do |fh|
-				fh.print( announce_body )
+				edit task.name
 			end
+			CLOBBER.include( RELEASE_ANNOUNCE_FILE )
 
-			edit task.name
-		end
-		CLOBBER.include( RELEASE_ANNOUNCE_FILE )
 
+			desc 'Send out a release announcement'
+			task :announce => [RELEASE_ANNOUNCE_FILE] do
+				email         = TMail::Mail.new
 
-		desc 'Send out a release announcement'
-		task :announce => [RELEASE_ANNOUNCE_FILE] do
-			email         = TMail::Mail.new
+				if $publish_privately || RELEASE_ANNOUNCE_ADDRESSES.empty?
+					trace "Sending private announce mail"
+					email.to = 'rubymage@gmail.com'
+				else
+					trace "Sending public announce mail"
+					email.to  = RELEASE_ANNOUNCE_ADDRESSES
+					email.bcc = 'rubymage@gmail.com'
+				end
 
-			if $publish_privately || RELEASE_ANNOUNCE_ADDRESSES.empty?
-				trace "Sending private announce mail"
-				email.to = 'rubymage@gmail.com'
-			else
-				trace "Sending public announce mail"
-				email.to  = RELEASE_ANNOUNCE_ADDRESSES
-				email.bcc = 'rubymage@gmail.com'
-			end
-			email.from    = 'Michael Granger <mgranger@laika.com>'
-			email.subject = "[ANN] #{PKG_NAME} #{PKG_VERSION}"
-			email.body    = File.read( RELEASE_ANNOUNCE_FILE )
-			email.date    = Time.new
-
-			email.message_id = gen_message_id()
-
-			log "About to send the following email:"
-			puts '---',
-			     email.to_s,
-			     '---'
-
-				ask_for_confirmation( "Will send via #{SMTP_HOST}." ) do
-				pwent = Etc.getpwuid( Process.euid )
-				curuser = pwent ? pwent.name : 'unknown'
-				username = prompt_with_default( "SMTP user", curuser )
-				password = prompt_for_password()
-
-				trace "Creating SMTP connection to #{SMTP_HOST}:#{SMTP_PORT}"
-				smtp = Net::SMTP.new( SMTP_HOST, SMTP_PORT )
-				smtp.set_debug_output( $stdout )
-				smtp.esmtp = true
-
-				trace "connecting..."
-				smtp.ssl_start( Socket.gethostname, username, password, :plain ) do |smtp|
-					trace "sending message..."
-					smtp.send_message( email.to_s, email.from, email.to )
+				from = prompt_with_default( "Send announcement as:",
+					'Michael Granger <ged@FaerieMUD.org>' ) or fail
+
+				email.from    = from
+				email.subject = "[ANN] #{PKG_NAME} #{PKG_VERSION}"
+				email.body    = File.read( RELEASE_ANNOUNCE_FILE )
+				email.date    = Time.new
+
+				email.message_id = gen_message_id()
+
+				log "About to send the following email:"
+				puts '---',
+				     email.to_s,
+				     '---'
+
+					ask_for_confirmation( "Will send via #{SMTP_HOST}." ) do
+					pwent = Etc.getpwuid( Process.euid )
+					curuser = pwent ? pwent.name : 'unknown'
+					username = prompt_with_default( "SMTP user", curuser )
+					password = prompt_for_password()
+
+					trace "Creating SMTP connection to #{SMTP_HOST}:#{SMTP_PORT}"
+					smtp = Net::SMTP.new( SMTP_HOST, SMTP_PORT )
+					smtp.set_debug_output( $stdout )
+					smtp.esmtp = true
+
+					trace "connecting..."
+					smtp.ssl_start( Socket.gethostname, username, password, :plain ) do |smtp|
+						trace "sending message..."
+						smtp.send_message( email.to_s, email.from, email.to )
+					end
+					trace "done."
 				end
-				trace "done."
 			end
 		end
 
-
-		desc 'Publish the new release to Gemcutter'
-		task :publish => [:clean, :gem, :notes] do |task|
-			ask_for_confirmation( "Publish #{GEM_FILE_NAME} to Gemcutter?", false ) do
-				gempath = PKGDIR + GEM_FILE_NAME
-				sh 'gem', 'push', gempath
+		if GEM_PUBHOST.empty?
+			task :no_gem_host do
+				log "Skipping gem push: no gem publication host."
+			end
+			task :publish => :no_gem_host
+		else
+			desc 'Publish the new gem to #{GEM_PUBHOST}'
+			task :publish => [:clean, :gem, :notes] do |task|
+				ask_for_confirmation( "Publish #{GEM_FILE_NAME} to #{GEM_PUBHOST}?", false ) do
+					gempath = PKGDIR + GEM_FILE_NAME
+					push_gem( gempath, GEM_PUBHOST )
+				end
 			end
 		end
 	end
@@ -262,6 +328,7 @@ rescue LoadError => err
 	end
 
 	task :release => :no_release_tasks
+	task "release:rerelease" => :no_release_tasks
 	task "release:announce" => :no_release_tasks
 	task "release:publish" => :no_release_tasks
 	task "release:notes" => :no_release_tasks

data/rake/testing.rb

@@ -16,7 +16,7 @@ end
 SPEC_FILES       = [] unless defined?( SPEC_FILES )
 TEST_FILES       = [] unless defined?( TEST_FILES )
 
-COMMON_SPEC_OPTS = ['-Du'] unless defined?( COMMON_SPEC_OPTS )
+COMMON_RSPEC_OPTS = [] unless defined?( COMMON_RSPEC_OPTS )
 
 COVERAGE_TARGETDIR = BASEDIR + 'coverage' unless defined?( COVERAGE_TARGETDIR )
 RCOV_EXCLUDES      = 'spec,tests,/Library/Ruby,/var/lib,/usr/local/lib' unless
@@ -39,10 +39,10 @@ end
 
 ### RSpec specifications
 begin
-	gem 'rspec', '>= 1.1.3'
+	gem 'rspec', '>= 2.0.0'
 
-	require 'spec'
-	require 'spec/rake/spectask'
+	require 'rspec'
+	require 'rspec/core/rake_task'
 
 	### Task: spec
 	desc "Run specs"
@@ -51,137 +51,101 @@ begin
 	namespace :spec do
 		desc "Run rspec every time there's a change to one of the files"
 		task :autotest do
-			require 'autotest/rspec'
-
-			autotester = Autotest::Rspec.new
-			autotester.run
+			require 'autotest'
+			Autotest.add_discovery { "rspec2" }
+			Autotest.run
 		end
 
 		desc "Generate regular color 'doc' spec output"
-		Spec::Rake::SpecTask.new( :doc ) do |task|
-			task.spec_files = SPEC_FILES
-			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 's', '-c']
+		RSpec::Core::RakeTask.new( :doc ) do |task|
+			task.rspec_opts = COMMON_RSPEC_OPTS + ['-f', 'd', '-c']
 		end
 
 		desc "Generate spec output with profiling"
-		Spec::Rake::SpecTask.new( :profile ) do |task|
-			task.spec_files = SPEC_FILES
-			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'o']
+		RSpec::Core::RakeTask.new( :profile ) do |task|
+			task.rspec_opts = COMMON_RSPEC_OPTS + ['-f', 'p', '-p']
 		end
 
 		desc "Generate quiet non-colored plain-text output"
-		Spec::Rake::SpecTask.new( :quiet ) do |task|
-			task.spec_files = SPEC_FILES
-			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'p']
+		RSpec::Core::RakeTask.new( :quiet ) do |task|
+			task.rspec_opts = COMMON_RSPEC_OPTS + ['-f', 'p']
 		end
 
 		desc "Generate HTML output"
-		Spec::Rake::SpecTask.new( :html ) do |task|
-			task.spec_files = SPEC_FILES
-			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'h']
+		RSpec::Core::RakeTask.new( :html ) do |task|
+			task.rspec_opts = COMMON_RSPEC_OPTS + ['-f', 'h']
 		end
 
-	end
-rescue LoadError => err
-	task :no_rspec do
-		$stderr.puts "Specification tasks not defined: %s" % [ err.message ]
-	end
-
-	task :spec => :no_rspec
-	namespace :spec do
-		task :autotest => :no_rspec
-		task :doc => :no_rspec
-		task :profile => :no_rspec
-		task :quiet => :no_rspec
-		task :html => :no_rspec
-	end
-end
-
-
-### Test::Unit tests
-begin
-	require 'rake/testtask'
-
-	Rake::TestTask.new( :unittests ) do |task|
-		task.libs += [LIBDIR]
-		task.test_files = TEST_FILES
-		task.verbose = true
-	end
 
-rescue LoadError => err
-	task :no_test do
-		$stderr.puts "Test tasks not defined: %s" % [ err.message ]
 	end
 
-	task :unittests => :no_rspec
-end
-
-
-### RCov (via RSpec) tasks
-begin
-	gem 'rcov'
-	gem 'rspec', '>= 1.1.3'
-
-	require 'spec'
-	require 'rcov'
-
 	### Task: coverage (via RCov)
 	desc "Build test coverage reports"
-	unless SPEC_FILES.empty?
-		Spec::Rake::SpecTask.new( :coverage ) do |task|
-			task.spec_files = SPEC_FILES
-			task.libs += [LIBDIR]
-			task.spec_opts = ['-f', 'p', '-b']
-			task.rcov_opts = RCOV_OPTS
-			task.rcov = true
-		end
+	RSpec::Core::RakeTask.new( :coverage ) do |task|
+		task.ruby_opts = [ "-I#{LIBDIR}" ]
+		task.rspec_opts = ['-f', 'p', '-b']
+		task.rcov_opts = RCOV_OPTS
+		task.rcov = true
 	end
 
-
 	### Task: rcov
 	task :rcov => :coverage
 
 	### Other coverage tasks
 	namespace :coverage do
 		desc "Generate a detailed text coverage report"
-		Spec::Rake::SpecTask.new( :text ) do |task|
-			task.spec_files = SPEC_FILES
+		RSpec::Core::RakeTask.new( :text ) do |task|
 			task.rcov_opts = RCOV_OPTS + ['--text-report']
 			task.rcov = true
 		end
 
 		desc "Show differences in coverage from last run"
-		Spec::Rake::SpecTask.new( :diff ) do |task|
-			task.spec_files = SPEC_FILES
-			task.spec_opts = ['-f', 'p', '-b']
+		RSpec::Core::RakeTask.new( :diff ) do |task|
+			task.rspec_opts = ['-f', 'p', '-b']
 			task.rcov_opts = RCOV_OPTS - ['--save'] + ['--text-coverage-diff']
 			task.rcov = true
 		end
 
 		desc "Run RCov in 'spec-only' mode to check coverage from specs"
-		Spec::Rake::SpecTask.new( :speconly ) do |task|
-			task.spec_files = SPEC_FILES
+		RSpec::Core::RakeTask.new( :speconly ) do |task|
 			task.rcov_opts = ['--exclude', RCOV_EXCLUDES, '--text-report', '--save']
 			task.rcov = true
 		end
 	end
 
 	CLOBBER.include( COVERAGE_TARGETDIR )
-
 rescue LoadError => err
-	task :no_rcov do
-		$stderr.puts "Coverage tasks not defined: RSpec+RCov tasklib not available: %s" %
-		[ err.message ]
+	task :no_rspec do
+		$stderr.puts "Specification tasks not defined: %s" % [ err.message ]
 	end
 
-	task :coverage => :no_rcov
-	task :clobber_coverage
-	task :rcov => :no_rcov
-	namespace :coverage do
-		task :text => :no_rcov
-		task :diff => :no_rcov
+	task :spec => :no_rspec
+	namespace :spec do
+		task :autotest => :no_rspec
+		task :doc => :no_rspec
+		task :profile => :no_rspec
+		task :quiet => :no_rspec
+		task :html => :no_rspec
 	end
-	task :verify => :no_rcov
+end
+
+
+### Test::Unit tests
+begin
+	require 'rake/testtask'
+
+	Rake::TestTask.new( :unittests ) do |task|
+		task.libs += [LIBDIR]
+		task.test_files = TEST_FILES
+		task.verbose = true
+	end
+
+rescue LoadError => err
+	task :no_test do
+		$stderr.puts "Test tasks not defined: %s" % [ err.message ]
+	end
+
+	task :unittests => :no_rspec
 end