darkfish-rdoc 1.1.1

data/rake/packaging.rb

@@ -0,0 +1,112 @@
+# 
+# Packaging Rake Tasks
+# $Id: packaging.rb 21 2008-08-07 23:45:52Z deveiant $
+# 
+
+require 'rbconfig'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+include Config
+
+### Task: gem
+### Task: package
+Rake::PackageTask.new( PKG_NAME, PKG_VERSION ) do |task|
+  	task.need_tar_gz   = true
+	task.need_tar_bz2  = true
+	task.need_zip      = true
+	task.package_dir   = PKGDIR.to_s
+  	task.package_files = RELEASE_FILES.
+		collect {|f| f.relative_path_from(BASEDIR).to_s }
+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
+
+### Task: install
+desc "Install #{PKG_NAME} as a conventional library"
+task :install do
+	log "Installing #{PKG_NAME} as a conventional library"
+	sitelib = Pathname.new( CONFIG['sitelibdir'] )
+	sitearch = Pathname.new( CONFIG['sitearchdir'] )
+	Dir.chdir( LIBDIR ) do
+		LIB_FILES.each do |libfile|
+			relpath = libfile.relative_path_from( LIBDIR )
+			target = sitelib + relpath
+			FileUtils.mkpath target.dirname,
+				:mode => 0755, :verbose => true, :noop => $dryrun unless target.dirname.directory?
+			FileUtils.install relpath, target,
+				:mode => 0644, :verbose => true, :noop => $dryrun
+		end
+	end
+	if EXTDIR.exist?
+		Dir.chdir( EXTDIR ) do
+			Pathname.glob( EXTDIR + Config::CONFIG['DLEXT'] ) do |dl|
+				target = sitearch + dl.basename
+				FileUtils.install dl, target, 
+					:mode => 0755, :verbose => true, :noop => $dryrun
+			end
+		end
+	end
+end
+
+
+
+### Task: install_gem
+desc "Install #{PKG_NAME} from a locally-built gem"
+task :install_gem => [:package] do
+	$stderr.puts 
+	installer = Gem::Installer.new( %{pkg/#{PKG_FILE_NAME}.gem} )
+	installer.install
+end
+
+
+### Task: uninstall
+desc "Uninstall #{PKG_NAME} if it's been installed as a conventional library"
+task :uninstall do
+	log "Uninstalling conventionally-installed #{PKG_NAME} library files"
+	sitelib = Pathname.new( CONFIG['sitelibdir'] )
+	sitearch = Pathname.new( CONFIG['sitearchdir'] )
+
+	Dir.chdir( LIBDIR ) do
+		LIB_FILES.each do |libfile|
+			relpath = libfile.relative_path_from( LIBDIR )
+			target = sitelib + relpath
+			FileUtils.rm_f target, :verbose => true, :noop => $dryrun
+			FileUtils.rm_rf( target.dirname, :verbose => true, :noop => $dryrun ) if
+				target.dirname.entries.empty?
+		end
+	end
+	if EXTDIR.exist?
+		Dir.chdir( EXTDIR ) do
+			Pathname.glob( EXTDIR + Config::CONFIG['DLEXT'] ) do |dl|
+				target = sitearch + dl.basename
+				FileUtils.rm target, :verbose => true, :noop => $dryrun
+			end
+		end
+	end
+end
+
+
+### Task: uninstall_gem
+desc "Install the #{PKG_NAME} gem"
+task :uninstall_gem => [:clean] do
+	uninstaller = Gem::Uninstaller.new( PKG_FILE_NAME )
+	uninstaller.uninstall
+end
+
+
+

data/rake/publishing.rb

@@ -0,0 +1,301 @@
+#####################################################################
+###	P U B L I C A T I O N   T A S K S
+#####################################################################
+
+RELEASE_NOTES_FILE    = 'release.notes'
+RELEASE_ANNOUNCE_FILE = 'release.ann'
+
+require 'net/smtp'
+require 'net/protocol'
+require 'openssl'
+
+$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
+				do_ssl_start( helo, user, secret, authtype )
+				return yield( self )
+			ensure
+				do_finish
+			end
+		else
+			do_ssl_start( helo, user, secret, authtype )
+			return self
+		end
+	end
+	
+	
+	#######
+	private
+	#######
+
+	def do_ssl_start( helodomain, user, secret, authtype )
+		raise IOError, 'SMTP session already started' if @started
+		check_auth_args user, secret, authtype if user or secret
+
+		# Open the connection
+      	@debug_output << "opening connection to #{@address}...\n" if @debug_output
+		sock = timeout( @open_timeout ) { TCPsocket.new(@address, @port) }
+
+		# Wrap it in the SSL layer
+		ssl_context = OpenSSL::SSL::SSLContext.new
+		ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+		ssl_sock = OpenSSL::SSL::SSLSocket.new( sock, ssl_context )
+		ssl_sock.sync_close = true
+		ssl_sock.connect
+
+		# Wrap it in the message-oriented IO layer
+		sslmsgio = Net::InternetMessageIO.new( ssl_sock )
+		sslmsgio.read_timeout = @read_timeout
+		sslmsgio.debug_output = @debug_output
+
+		@socket = sslmsgio
+
+		check_response(critical { recv_response() })
+		begin
+			if @esmtp
+				ehlo helodomain
+			else
+				helo helodomain
+			end
+		rescue ProtocolError
+			if @esmtp
+				@esmtp = false
+				@error_occured = false
+				retry
+			end
+			raise
+		end
+		authenticate user, secret, authtype if user
+		@started = true
+	ensure
+		@socket.close if not @started and @socket and not @socket.closed?
+	end
+end
+
+
+begin
+	gem 'text-format'
+
+	require 'time'
+	require 'rake/tasklib'
+	require 'tmail'
+	require 'net/smtp'
+	require 'etc'
+	require 'rubyforge'
+	require 'socket'
+	require 'text/format'
+
+	### Generate a valid RFC822 message-id
+	def gen_message_id
+		return "<%s.%s@%s>" % [
+			(Time.now.to_f * 10000).to_i.to_s( 36 ),
+			(rand( 2 ** 64 - 1 )).to_s( 36 ),
+			Socket.gethostname
+		]
+	end
+
+
+	namespace :release do
+		task :default => [ 'svn:release', :publish, :announce, :project ]
+		task :test do
+			$publish_privately = true
+		end
+		task :test => [ 'svn:release', :publish, :announce, :project ]
+		
+		desc "Re-publish the release with the current version number"
+		task :rerelease => [ :publish, :announce, :project ]
+
+
+		desc "Generate the release notes"
+		task :notes => [RELEASE_NOTES_FILE]
+		file RELEASE_NOTES_FILE do |task|
+			last_rel_tag = get_latest_release_tag() or
+				fail ">>> No releases tagged! Try running 'rake svn:release' first"
+			trace "Last release tag is: %p" % [ last_rel_tag ]
+			start = get_last_changed_rev( last_rel_tag ) || 1
+			trace "Starting rev is: %p" % [ start ]
+			log_output = make_svn_log( '.', start, 'HEAD' )
+
+			File.open( task.name, File::WRONLY|File::TRUNC|File::CREAT ) do |fh|
+				fh.print( log_output )
+			end
+
+			edit task.name
+		end
+		
+		
+		task :project => [ :rdoc ] do
+			when_writing( "Publishing docs to #{PROJECT_SCPURL}" ) do
+				run 'ssh', PROJECT_HOST, "rm -rf #{PROJECT_DOCDIR}"
+				run 'scp', '-qCr', 'docs', PROJECT_SCPURL
+			end
+			when_writing( "Uploading packages") do
+				pkgs = Pathname.glob( PKGDIR + "#{PKG_FILE_NAME}.{gem,tar.gz,tar.bz2,zip}" )
+				log "Uploading %d packages to #{PROJECT_PUBURL}" % [ pkgs.length ]
+				pkgs.each do |pkgfile|
+					run 'scp', '-qC', pkgfile, PROJECT_PUBURL
+                end
+            end
+		end
+
+		
+		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)}
+
+				== Project Page
+
+				  #{GEMSPEC.homepage}
+
+				== Installation
+
+				Via gems:
+				
+				  $ sudo gem install #{GEMSPEC.name}
+
+				or from source:
+
+				  $ 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+/, '' )
+			
+			File.open( task.name, File::WRONLY|File::TRUNC|File::CREAT ) do |fh|
+				fh.print( announce_body )
+			end
+
+			edit task.name
+		end
+		
+		
+		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      = 'rubymage@gmail.com'
+				# 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
+		
+	
+		desc 'Publish the new release to RubyForge'
+		task :publish => [:clobber, :package, :notes] do |task|
+			project = GEMSPEC.rubyforge_project
+
+			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 )
+				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 )
+				fail "Rubyforge seems to already have #{ PKG_FILE_NAME }"
+			end
+
+			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 )
+			config['preformatted'] = true
+
+			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
+		end
+	end
+	
+rescue LoadError => err
+	if !Object.const_defined?( :Gem )
+		require 'rubygems'
+		retry
+	end
+	
+	task :no_release_tasks do
+		fail "Release tasks not defined: #{err.message}"
+	end
+	
+	task :release => :no_release_tasks
+	task "release:announce" => :no_release_tasks
+	task "release:publish" => :no_release_tasks
+	task "release:notes" => :no_release_tasks
+end
+
+task :release => 'release:default'
+

data/rake/rdoc.rb

@@ -0,0 +1,30 @@
+# 
+# RDoc Rake tasks for ThingFish
+# $Id: rdoc.rb 20 2008-08-07 15:50:54Z deveiant $
+# 
+
+require 'rake/rdoctask'
+$have_darkfish = false
+
+begin
+	require 'darkfish-rdoc'
+	$have_darkfish = true
+rescue LoadError => err
+	unless Object.const_defined?( :Gem )
+		require 'rubygems'
+		gem 'darkfish-rdoc'
+		retry
+	end
+	
+	log "No DarkFish: %s: %s" % [ err.class.name, err.message ]
+	trace "Backtrace:\n  %s" % [ err.backtrace.join("\n  ") ]
+end
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'docs'
+	rdoc.title    = "#{PKG_NAME} - #{PKG_SUMMARY}"
+	rdoc.options += RDOC_OPTIONS + [ '-f', 'darkfish' ] if $have_darkfish
+
+	rdoc.rdoc_files.include 'README'
+	rdoc.rdoc_files.include LIB_FILES.collect {|f| f.to_s }
+end

data/rake/style.rb

@@ -0,0 +1,62 @@
+# 
+# Style Fixup Rake Tasks
+# $Id: style.rb 10 2008-07-18 15:52:48Z deveiant $
+# 
+# Authors:
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+
+### Coding style checks and fixes
+namespace :style do
+	
+	BLANK_LINE = /^\s*$/
+	GOOD_INDENT = /^(\t\s*)?\S/
+
+	# A list of the files that have legitimate leading whitespace, etc.
+	PROBLEM_FILES = [ SPECDIR + 'config_spec.rb' ]
+	
+	desc "Check source files for inconsistent indent and fix them"
+	task :fix_indent do
+		files = LIB_FILES + SPEC_FILES
+
+		badfiles = Hash.new {|h,k| h[k] = [] }
+		
+		trace "Checking files for indentation"
+		files.each do |file|
+			if PROBLEM_FILES.include?( file )
+				trace "  skipping problem file #{file}..."
+				next
+			end
+			
+			trace "  #{file}"
+			linecount = 0
+			file.each_line do |line|
+				linecount += 1
+				
+				# Skip blank lines
+				next if line =~ BLANK_LINE
+				
+				# If there's a line with incorrect indent, note it and skip to the 
+				# next file
+				if line !~ GOOD_INDENT
+					trace "    Bad line %d: %p" % [ linecount, line ]
+					badfiles[file] << [ linecount, line ]
+				end
+			end
+		end
+
+		if badfiles.empty?
+			log "No indentation problems found."
+		else
+			log "Found incorrect indent in #{badfiles.length} files:\n  "
+			badfiles.each do |file, badlines|
+				log "  #{file}:\n" +
+					"    " + badlines.collect {|badline| "%5d: %p" % badline }.join( "\n    " )
+			end
+		end
+	end
+
+end
+
+