darkfish-rdoc 1.1.1 → 1.1.2

data/rake/helpers.rb

@@ -108,7 +108,7 @@ def download( sourceuri, targetfile=nil )
 	log "Downloading %s to %s" % [sourceuri, targetfile]
 	targetpath.open( File::WRONLY|File::TRUNC|File::CREAT, 0644 ) do |ofh|
 	
-		url = URI.parse( sourceuri )
+		url = sourceuri.is_a?( URI ) ? sourceuri : URI.parse( sourceuri )
 		downloaded = false
 		limit = 5
 		
@@ -279,6 +279,38 @@ def prompt_for_multiple_values( label, default=nil )
 end
 
 
+### Turn echo and masking of input on/off. Based on similar code in
+### Ruby-Password by Ian Macdonald <ian@caliban.org>.
+def noecho( masked=false )
+	require 'termios'
+
+	rval = nil
+	term = Termios.getattr( $stdin )
+
+	begin
+		term.c_lflag &= ~Termios::ECHO
+		term.c_lflag &= ~Termios::ICANON if masked
+
+		rval = yield
+	ensure
+		term.c_lflag |= ( Termios::ECHO | Termios::ICANON )
+		Termios.setattr( $stdin, Termios::TCSANOW, term )
+	end
+	
+	return rval
+end
+
+
+### Prompt the user for her password, turning off echo if the 'termios' module is
+### available.
+def prompt_for_password( prompt="Password: " )
+	return noecho( true ) do
+		$stderr.print( prompt )
+		($stdin.gets || '').chomp
+	end
+end
+
+
 ### Display a description of a potentially-dangerous task, and prompt
 ### for confirmation. If the user answers with anything that begins
 ### with 'y', yield to the block, else raise with an error.

data/rake/publishing.rb

@@ -101,14 +101,15 @@ begin
 
 	namespace :release do
 		task :default => [ 'svn:release', :publish, :announce, :project ]
+
+		desc "Re-publish the release with the current version number"
+		task :rerelease => [ :publish, :announce, :project ]
+
 		task :test do
 			$publish_privately = true
 		end
-		task :test => [ 'svn:release', :publish, :announce, :project ]
+		task :test => [ :rerelease ]
 		
-		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]
@@ -126,18 +127,19 @@ begin
 
 			edit task.name
 		end
+		CLEAN.include( RELEASE_NOTES_FILE )
 		
 		
 		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
+			when_writing( "Publishing docs to #{PROJECT_SCPDOCURL}" ) do
+				run 'ssh', PROJECT_HOST, "rm -rf #{PROJECT_SCPDOCURL}"
+				run 'scp', '-qCr', 'docs', PROJECT_SCPDOCURL
 			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 ]
+				log "Uploading %d packages to #{PROJECT_SCPPUBURL}" % [ pkgs.length ]
 				pkgs.each do |pkgfile|
-					run 'scp', '-qC', pkgfile, PROJECT_PUBURL
+					run 'scp', '-qC', pkgfile, PROJECT_SCPPUBURL
                 end
             end
 		end
@@ -178,6 +180,7 @@ begin
 
 			edit task.name
 		end
+		CLEAN.include( RELEASE_ANNOUNCE_FILE )
 		
 		
 		desc 'Send out a release announcement'
@@ -249,33 +252,32 @@ begin
 			# 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 )
+				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
 			end
 		end

data/rake/rdoc.rb

@@ -1,6 +1,6 @@
 # 
 # RDoc Rake tasks for ThingFish
-# $Id: rdoc.rb 20 2008-08-07 15:50:54Z deveiant $
+# $Id: rdoc.rb 28 2008-08-13 04:50:05Z deveiant $
 # 
 
 require 'rake/rdoctask'
@@ -21,7 +21,7 @@ rescue LoadError => err
 end
 
 Rake::RDocTask.new do |rdoc|
-	rdoc.rdoc_dir = 'docs'
+	rdoc.rdoc_dir = 'docs/html'
 	rdoc.title    = "#{PKG_NAME} - #{PKG_SUMMARY}"
 	rdoc.options += RDOC_OPTIONS + [ '-f', 'darkfish' ] if $have_darkfish
 

data/rake/svn.rb

@@ -1,6 +1,6 @@
 # 
 # Subversion Rake Tasks
-# $Id: svn.rb 22 2008-08-08 01:30:06Z deveiant $
+# $Id: svn.rb 30 2008-08-13 23:31:25Z deveiant $
 # 
 # Authors:
 # * Michael Granger <ged@FaerieMUD.org>
@@ -253,7 +253,13 @@ def make_svn_changelog( dir='.' )
 		end
 
 		date = Time.parse( entry.find_first('date').content )
-		author = entry.find_first( 'author' ).content
+
+		# cvs2svn doesn't set 'author'
+		author = 'unknown'
+		if entry.find_first( 'author' )
+			author = entry.find_first( 'author' ).content
+		end
+		              
 		msg = entry.find_first( 'msg' ).content
 		rev = entry['revision']
 
@@ -313,11 +319,25 @@ namespace :svn do
 	task :release do
 		last_tag    = get_latest_svn_timestamp_tag()
 		svninfo     = get_svn_info()
-		svntrunk    = svninfo['Repository Root'] + "/#{SVN_TRUNK_DIR}"
-		svnrel      = svninfo['Repository Root'] + "/#{SVN_RELEASES_DIR}"
+		svnroot     = svninfo['Repository Root']
+		svntrunk    = svnroot + "/#{SVN_TRUNK_DIR}"
+		svnrel      = svnroot + "/#{SVN_RELEASES_DIR}"
 		release     = PKG_VERSION
 		svnrelease  = svnrel + '/' + release
 
+		topdirs = svn_ls( svnroot ).collect {|dir| dir.chomp('/') }
+		unless topdirs.include?( SVN_RELEASES_DIR )
+			trace "Top directories (%p) does not include %p" %
+				[ topdirs, SVN_RELEASES_DIR ]
+			log "Releases path #{svnrel} does not exist."
+			ask_for_confirmation( "To continue I'll need to create it." ) do
+				run 'svn', 'mkdir', svnrel, '-m', 'Creating releases/ directory'
+			end
+		else
+			trace "Found release dir #{SVN_RELEASES_DIR} in the top directories %p" %
+				[ topdirs ]
+		end
+
 		releases = svn_ls( svnrel ).collect {|name| name.sub(%r{/$}, '') }
 		trace "Releases: %p" % [releases]
 		if releases.include?( release )
@@ -372,7 +392,7 @@ namespace :svn do
 
 
 	desc "Check in all the changes in your current working copy"
-	task :checkin => ['svn:update', 'coverage:verify', 'svn:fix_keywords', COMMIT_MSG_FILE] do
+	task :checkin => ['svn:update', 'test', 'svn:fix_keywords', COMMIT_MSG_FILE] do
 		targets = get_target_args()
 		$deferr.puts '---', File.read( COMMIT_MSG_FILE ), '---'
 		ask_for_confirmation( "Continue with checkin?" ) do
@@ -382,7 +402,7 @@ namespace :svn do
 	end
 	task :commit => :checkin
 	task :ci => :checkin
-		
+	
 	
 	task :clean do
 		rm_f COMMIT_MSG_FILE

data/spec/rdoc/generator/darkfish_spec.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent.parent
+	
+	libdir = basedir + "lib"
+	
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+begin
+	require 'spec/runner'
+	require 'rdoc/generator/darkfish'
+rescue LoadError
+	unless Object.const_defined?( :Gem )
+		require 'rubygems'
+		retry
+	end
+	raise
+end
+
+
+describe RDoc::Generator::Darkfish do
+
+	it "can create an instance via the generator factory method" do
+		RDoc::Generator::Darkfish.for( 'darkfish' ).
+			should be_an_instance_of( RDoc::Generator::Darkfish )
+	end
+	
+
+	describe "an instance" do
+		
+		before( :each ) do
+			@generator = RDoc::Generator::Darkfish.for( 'darkfish' )
+		end
+		
+		
+		it "generates the required subdirectories" do
+			@generator.outputdir.should_receive( :mkpath )
+			@generator.gen_sub_directories
+		end
+		
+		
+		it "copies static files over during #write_style_sheet" do
+			FileUtils.should_receive( :cp_r ).
+				with( an_instance_of(Pathname), '.', :verbose => $DEBUG ).
+				exactly( 3 ).times
+			@generator.write_style_sheet
+		end
+		
+	end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: darkfish-rdoc
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - Michael Granger
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-07 00:00:00 -07:00
+date: 2008-08-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: "rdoc: >= 2.1.0"
+  name: rdoc
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.1.0
     version: 
 description: A complete replacement for the default HTML generator for Rdoc, the API documentation-extraction system for Ruby.
 email: ged@FaerieMUD.org
@@ -35,6 +35,7 @@ files:
 - ChangeLog
 - README
 - LICENSE
+- spec/rdoc/generator/darkfish_spec.rb
 - lib/darkfish-rdoc.rb
 - lib/rdoc/generator/darkfish.rb
 - rake/dependencies.rb
@@ -47,6 +48,28 @@ files:
 - rake/svn.rb
 - rake/testing.rb
 - rake/verifytask.rb
+- lib/rdoc/generator/template/darkfish/rdoc.css
+- lib/rdoc/generator/template/darkfish/classpage.rhtml
+- lib/rdoc/generator/template/darkfish/filepage.rhtml
+- lib/rdoc/generator/template/darkfish/index.rhtml
+- lib/rdoc/generator/template/darkfish/images/brick.png
+- lib/rdoc/generator/template/darkfish/images/brick_link.png
+- lib/rdoc/generator/template/darkfish/images/bullet_black.png
+- lib/rdoc/generator/template/darkfish/images/date.png
+- lib/rdoc/generator/template/darkfish/images/macFFBgHack.png
+- lib/rdoc/generator/template/darkfish/images/package.png
+- lib/rdoc/generator/template/darkfish/images/page_green.png
+- lib/rdoc/generator/template/darkfish/images/page_white_width.png
+- lib/rdoc/generator/template/darkfish/images/plugin.png
+- lib/rdoc/generator/template/darkfish/images/ruby.png
+- lib/rdoc/generator/template/darkfish/images/tag_green.png
+- lib/rdoc/generator/template/darkfish/images/wrench.png
+- lib/rdoc/generator/template/darkfish/images/wrench_orange.png
+- lib/rdoc/generator/template/darkfish/images/zoom.png
+- lib/rdoc/generator/template/darkfish/js/darkfish.js
+- lib/rdoc/generator/template/darkfish/js/jquery.js
+- lib/rdoc/generator/template/darkfish/js/quicksearch.js
+- lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js
 - Rakefile.local
 has_rdoc: true
 homepage: http://deveiate.org/projects/Darkfish-Rdoc/
@@ -82,5 +105,5 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: A pretty (different) Rdoc HTML generator
-test_files: []
-
+test_files: 
+- spec/rdoc/generator/darkfish_spec.rb