darkfish-rdoc 1.1.1

data/rake/verifytask.rb

@@ -0,0 +1,64 @@
+#####################################################################
+###	S U B V E R S I O N   T A S K S   A N D   H E L P E R S
+#####################################################################
+
+require 'rake/tasklib'
+
+#
+# Work around the inexplicable behaviour of the original RDoc::VerifyTask, which 
+# errors if your coverage isn't *exactly* the threshold.
+# 
+
+# A task that can verify that the RCov coverage doesn't
+# drop below a certain threshold. It should be run after
+# running Spec::Rake::SpecTask.
+class VerifyTask < Rake::TaskLib
+	
+	COVERAGE_PERCENTAGE_PATTERN = 
+		%r{<tt class='coverage_code'>(\d+\.\d+)%</tt>}
+	
+	# Name of the task. Defaults to :verify_rcov
+	attr_accessor :name
+
+	# Path to the index.html file generated by RCov, which
+	# is the file containing the total coverage.
+	# Defaults to 'coverage/index.html'
+	attr_accessor :index_html
+
+	# Whether or not to output details. Defaults to true.
+	attr_accessor :verbose
+
+	# The threshold value (in percent) for coverage. If the 
+	# actual coverage is not equal to this value, the task will raise an 
+	# exception. 
+	attr_accessor :threshold
+
+	def initialize( name=:verify )
+		@name = name
+		@index_html = 'coverage/index.html'
+		@verbose = true
+		yield self if block_given?
+		raise "Threshold must be set" if @threshold.nil?
+		define
+	end
+
+	def define
+		desc "Verify that rcov coverage is at least #{threshold}%"
+
+		task @name do
+			total_coverage = nil
+			if match = File.read( index_html ).match( COVERAGE_PERCENTAGE_PATTERN )
+				total_coverage = Float( match[1] )
+			else
+				raise "Couldn't find the coverage percentage in #{index_html}"
+			end
+
+			puts "Coverage: #{total_coverage}% (threshold: #{threshold}%)" if verbose
+			if total_coverage < threshold
+				raise "Coverage must be at least #{threshold}% but was #{total_coverage}%"
+			end
+		end
+	end
+end
+
+# vim: set nosta noet ts=4 sw=4:

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: darkfish-rdoc
+version: !ruby/object:Gem::Version 
+  version: 1.1.1
+platform: ruby
+authors: 
+- Michael Granger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: "rdoc: >= 2.1.0"
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A complete replacement for the default HTML generator for Rdoc, the API documentation-extraction system for Ruby.
+email: ged@FaerieMUD.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- ChangeLog
+- README
+- LICENSE
+- lib/darkfish-rdoc.rb
+- lib/rdoc/generator/darkfish.rb
+- rake/dependencies.rb
+- rake/helpers.rb
+- rake/manual.rb
+- rake/packaging.rb
+- rake/publishing.rb
+- rake/rdoc.rb
+- rake/style.rb
+- rake/svn.rb
+- rake/testing.rb
+- rake/verifytask.rb
+- Rakefile.local
+has_rdoc: true
+homepage: http://deveiate.org/projects/Darkfish-Rdoc/
+post_install_message: 
+rdoc_options: 
+- -w
+- "4"
+- -SHN
+- -i
+- .
+- -m
+- README
+- -W
+- http://deveiate.org/projects/Darkfish-Rdoc//browser/trunk/
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: darkfish-rdoc
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A pretty (different) Rdoc HTML generator
+test_files: []
+