linguistics 1.0.8 → 1.0.9

data/rake/hg.rb

@@ -22,6 +22,8 @@ unless defined?( HG_DOTDIR )
 	### 
 
 	module MercurialHelpers
+		require './helpers.rb' unless defined?( RakefileHelpers )
+		include RakefileHelpers
 
 		###############
 		module_function
@@ -81,9 +83,18 @@ unless defined?( HG_DOTDIR )
 			return paths
 		end
 
+		### Return the list of files which are not of status 'clean'
+		def get_uncommitted_files
+			list = read_command_output( 'hg', 'status', '-n', '--color', 'never' )
+			list = list.split( /\n/ )
+
+			trace "Changed files: %p" % [ list ]
+			return list
+		end
+
 		### 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 ]
@@ -147,11 +158,21 @@ unless defined?( HG_DOTDIR )
 
 		desc "Prepare for a new release"
 		task :prep_release do
+			uncommitted_files = get_uncommitted_files()
+			unless uncommitted_files.empty?
+				log "Uncommitted files:\n",
+				    *uncommitted_files.map {|fn| "  #{fn}\n" }
+				ask_for_confirmation( "\nRelease anyway?", true ) do
+					log "Okay, releasing with uncommitted versions."
+				end
+			end
+
 			tags = get_tags()
 			rev = get_current_rev()
+			pkg_version_tag = "v#{PKG_VERSION}"
 
 			# Look for a tag for the current release version, and if it exists abort
-			if tags.include?( PKG_VERSION )
+			if tags.include?( pkg_version_tag )
 				error "Version #{PKG_VERSION} already has a tag. Did you mean " +
 					"to increment the version in #{VERSION_FILE}?"
 				fail
@@ -162,8 +183,8 @@ unless defined?( HG_DOTDIR )
 			run 'hg', 'sign'
 
 			# Tag the current rev
-			log "Tagging rev #{rev} as #{PKG_VERSION}"
-			run 'hg', 'tag', PKG_VERSION
+			log "Tagging rev #{rev} as #{pkg_version_tag}"
+			run 'hg', 'tag', pkg_version_tag
 
 			# Offer to push
 			Rake::Task['hg:push'].invoke
@@ -208,8 +229,39 @@ unless defined?( HG_DOTDIR )
 		task :add => :newfiles
 
 
+		desc "Pull and update from the default repo"
+		task :pull do
+			paths = get_repo_paths()
+			if origin_url = paths['default']
+				ask_for_confirmation( "Pull and update from '#{origin_url}'?", false ) do
+					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 "Update to tip"
+		task :update do
+			run 'hg', 'update'
+		end
+
+
+		desc "Clobber all changes (hg up -C)"
+		task :update_and_clobber do
+			run 'hg', 'update', '-C'
+		end
+
+
 		desc "Check the current code in if tests pass"
-		task :checkin => ['hg:newfiles', 'test', COMMIT_MSG_FILE] do
+		task :checkin => ['hg:pull', 'hg:newfiles', 'test', COMMIT_MSG_FILE] do
 			targets = get_target_args()
 			$stderr.puts '---', File.read( COMMIT_MSG_FILE ), '---'
 			ask_for_confirmation( "Continue with checkin?" ) do
@@ -228,13 +280,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

@@ -1,17 +1,27 @@
-# 
-# Packaging Rake Tasks
-
-# 
+#####################################################################
+###	P A C K A G I N G   T A S K S
+#####################################################################
 
 require 'rbconfig'
 require 'pathname'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 
-require Pathname( __FILE__ ).dirname.expand_path + 'hg.rb'
 
 include Config
 
+### Task: prerelease
+desc "Append the package build number to package versions"
+task :prerelease do
+	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
+
+
 ### Task: gem
 ### Task: package
 Rake::PackageTask.new( PKG_NAME, PKG_VERSION ) do |task|
@@ -24,34 +34,9 @@ end
 task :package => [:gem]
 
 
-### Task: gem
-gempath = PKGDIR + GEM_FILE_NAME
-
-desc "Build a RubyGem package (#{GEM_FILE_NAME})"
-task :gem => gempath.to_s
-file gempath.to_s => [PKGDIR.to_s] + GEMSPEC.files do
-	when_writing( "Creating GEM" ) do
-		Gem::Builder.new( GEMSPEC ).build
-		verbose( true ) do
-			mv GEM_FILE_NAME, gempath
-		end
-	end
-end
-
-
-prerelease_gempath = PKGDIR + SNAPSHOT_GEM_NAME
-
-desc "Build a pre-release RubyGem package"
-task :prerelease_gem => prerelease_gempath.to_s
-file prerelease_gempath.to_s => [PKGDIR.to_s] + GEMSPEC.files do
-	when_writing( "Creating prerelease GEM" ) do
-		gemspec = GEMSPEC.clone
-		gemspec.version = Gem::Version.create( "%s.%s" % [GEMSPEC.version, PKG_BUILD] )
-		Gem::Builder.new( gemspec ).build
-		verbose( true ) do
-			mv SNAPSHOT_GEM_NAME, prerelease_gempath
-		end
-	end
+Gem::PackageTask.new( GEMSPEC ) do |pkg|
+	pkg.need_zip = true
+	pkg.need_tar = true
 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
@@ -34,7 +37,13 @@ class Net::SMTP
 
 	def do_ssl_start( helodomain, user, secret, authtype )
 		raise IOError, 'SMTP session already started' if @started
-		check_auth_args user, secret if user or secret
+		if user or secret
+			if self.method( :check_auth_args ).arity == 3
+				check_auth_args( user, secret, authtype )
+			else
+				check_auth_args( user, secret )
+			end
+		end
 
 		# Open the connection
       	@debug_output << "opening connection to #{@address}...\n" if @debug_output
@@ -85,9 +94,11 @@ begin
 	require 'tmail'
 	require 'net/smtp'
 	require 'etc'
-	require 'rubyforge'
 	require 'socket'
 	require 'text/format'
+	require 'rubygems/gemcutter_utilities'
+
+	include Gem::GemcutterUtilities
 
 	### Generate a valid RFC822 message-id
 	def gen_message_id
@@ -99,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 ]
 
@@ -128,168 +181,137 @@ begin
 		end
 		CLOBBER.include( RELEASE_NOTES_FILE )
 
+		# 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
 
-		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
+			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
 
-		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
+		# 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
 
+		else
+			file RELEASE_ANNOUNCE_FILE => [RELEASE_NOTES_FILE] do |task|
+				relnotes = File.read( RELEASE_NOTES_FILE )
+				announce_body = %{
 
-		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.
 
-				Version #{PKG_VERSION} of #{PKG_NAME} has been released.
+					#{Text::Format.new(:first_indent => 0).format_one_paragraph(GEMSPEC.description)}
 
-				#{Text::Format.new(:first_indent => 0).format_one_paragraph(GEMSPEC.description)}
+					== Project Page
 
-				== Project Page
+					  #{GEMSPEC.homepage}
 
-				  #{GEMSPEC.homepage}
+					== Installation
 
-				== Installation
+					  $ sudo gem install #{GEMSPEC.name}
 
-				Via gems:
+					== Changes
+					#{relnotes}
+				}.gsub( /^\t+/, '' )
 
-				  $ sudo gem install #{GEMSPEC.name}
+				File.open( task.name, File::WRONLY|File::TRUNC|File::CREAT ) do |fh|
+					fh.print( announce_body )
+				end
 
-				or from source:
+				edit task.name
+			end
+			CLOBBER.include( RELEASE_ANNOUNCE_FILE )
 
-				  $ 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+/, '' )
+			desc 'Send out a release announcement'
+			task :announce => [RELEASE_ANNOUNCE_FILE] do
+				email         = TMail::Mail.new
 
-			File.open( task.name, File::WRONLY|File::TRUNC|File::CREAT ) do |fh|
-				fh.print( announce_body )
-			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
 
-			edit task.name
-		end
-		CLOBBER.include( RELEASE_ANNOUNCE_FILE )
+				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
 
-		desc 'Send out a release announcement'
-		task :announce => [RELEASE_ANNOUNCE_FILE] do
-			email         = TMail::Mail.new
-			if $publish_privately
-				trace "Sending private announce mail"
-				email.to = 'rubymage@gmail.com'
-			else
-				trace "Sending public announce mail"
-				email.to  = 'Ruby-Talk List <ruby-talk@ruby-lang.org>'
-				email.bcc = 'rubymage@gmail.com'
-			end
-			email.from    = GEMSPEC.email
-			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
-		end
+				email.message_id = gen_message_id()
 
+				log "About to send the following email:"
+				puts '---',
+				     email.to_s,
+				     '---'
 
-		desc 'Publish the new release to RubyForge'
-		task :publish => [:clean, :package, :notes] do |task|
-			project = GEMSPEC.rubyforge_project
+					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()
 
-			if $publish_privately
-				log "Skipping push of release files to RubyForge"
-			else
-				rf = RubyForge.new
-				log "Loading RubyForge config"
-				rf.configure
-
-				group_id = rf.autoconfig['group_ids'][RUBYFORGE_GROUP] or
-					fail "Your configuration doesn't have a group id for '#{RUBYFORGE_GROUP}'"
-
-				# If this project doesn't yet exist, create it
-				unless rf.autoconfig['package_ids'].key?( project )
-					ask_for_confirmation( "Package '#{project}' doesn't exist on RubyForge. Create it?" ) do
-						log "Creating new package '#{project}'"
-						rf.create_package( group_id, project )
+					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
+			end
+		end
 
-				package_id = rf.autoconfig['package_ids'][ project ]
-
-				# Make sure this release doesn't already exist
-				releases = rf.autoconfig['release_ids']
-				if releases.key?( GEMSPEC.name ) && releases[ GEMSPEC.name ].key?( PKG_VERSION )
-					log "Rubyforge seems to already have #{ PKG_FILE_NAME }"
-				else
-					config = rf.userconfig or
-						fail "You apparently haven't set up your RubyForge credentials on this machine."
-					config['release_notes'] = GEMSPEC.description
-					config['release_changes'] = File.read( RELEASE_NOTES_FILE )
-
-					files = FileList[ PKGDIR + GEM_FILE_NAME ]
-					files.include PKGDIR + "#{PKG_FILE_NAME}.tar.gz"
-					files.include PKGDIR + "#{PKG_FILE_NAME}.tar.bz2"
-					files.include PKGDIR + "#{PKG_FILE_NAME}.zip"
-
-					log "Releasing #{PKG_FILE_NAME}"
-					when_writing do
-						log "Publishing to RubyForge: \n",
-							"\tproject: #{RUBYFORGE_GROUP}\n",
-							"\tpackage: #{PKG_NAME.downcase}\n",
-							"\tpackage version: #{PKG_VERSION}\n",
-							"\tfiles: " + files.collect {|f| f.to_s }.join(', ') + "\n"
-
-						ask_for_confirmation( "Publish to RubyForge?" ) do
-							log 'Logging in...'
-							rf.login
-							log "Adding the new release to the '#{project}' project"
-							rf.add_release( group_id, package_id, PKG_VERSION, *files )
-						end
-					end
+		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
@@ -306,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