rspec 0.5.0 → 0.5.1

data/CHANGES

@@ -1,13 +1,17 @@
 = RSpec Changelog
 
-== Version 0.5.0
+== Version 0.5.1
+This release is the first release of RSpec with a new website. It will look better soon.
 
-This release introduces a new API and obsoletes previous versions
-* Lots and lots of changes. See examples.
+* Added initial documentation for API [dastels]
+* Added website based on webgen [aslak_hellesoy]
+* Modified test task to use rcov [aslak_hellesoy]
+* Deleted unused code (thanks, rcov!) [aslak_hellesoy]
+* Various changes to the mock API [dastels]
 
-== Version 0.4.0
+== Version 0.5.0
 
-The "two Daves walked into a bar and Aslak ruined the party" release.
+This release introduces a new API and obsoletes previous versions.
 
 * Moved source code to separate subfolders
 * Added new DSL runner based on instance_exec

data/Rakefile

@@ -9,6 +9,7 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'lib/spec/version'
 require 'lib/spec/rake/spectask'
+require 'test/rake/rcov_testtask'
 
 PKG_NAME = "rspec"
 # Versioning scheme: MAJOR.MINOR.PATCH
@@ -16,11 +17,7 @@ PKG_NAME = "rspec"
 # MINOR bumps when the API is broken backwards in a very slight/subtle (but not fatal) way
 # -OR when a new release is made and propaganda is sent out.
 # PATCH is bumped for every API addition and/or bugfix (ideally for every commit)
-# Later DamageControl can bump PATCH automatically.
-#
-# (This is subject to change - AH)
-#
-# REMEMBER TO KEEP PKG_VERSION IN SYNC WITH CHANGELOG
+
 PKG_VERSION   = Spec::VERSION::STRING
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
@@ -44,21 +41,18 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-# text runner tests need to run individually
-#Rake::TestTask.new(:test_text_runner) do |t|
-#	t.libs << "test"
-#	t.libs << "examples"
-#	t.test_files = FileList['test/text_runner_test.rb']
-#	t.verbose = true
-#end
-
+# Generates the HTML documentation
+desc 'Generate documentation'
+task :doc do
+  sh %{pushd doc; webgen; popd }
+end
 
-# Create a task to build the RDOC documentation tree.
+desc 'Generate RDoc'
 rd = Rake::RDocTask.new("rdoc") do |rdoc|
-  rdoc.rdoc_dir = 'html'
+  rdoc.rdoc_dir = 'doc/output/rdoc'
   rdoc.title    = "RSpec"
   rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('README', 'CHANGES', 'TUTORIAL')
+  rdoc.rdoc_files.include('CHANGES')
   rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
   rdoc.rdoc_files.exclude('doc/**/*_attrs.rdoc')
 end
@@ -111,12 +105,10 @@ spec = Gem::Specification.new do |s|
   s.rubyforge_project = "rspec"
 end
 
-desc "Build Gem"
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.need_zip = true
   pkg.need_tar = true
 end
-task :gem => [:test]
 
 # Support Tasks ------------------------------------------------------
 
@@ -139,22 +131,40 @@ task :todo do
   egrep /#.*(FIXME|TODO|TBD)/
 end
 
-task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news]
+task :clobber do
+  rm_rf 'coverage'
+  rm_rf 'doc/output'
+end
+
+task :release => [:clobber, :test, :verify_env_vars, :upload_releases, :publish_website, :publish_news]
+
+task :rcov do
+  mv 'coverage', 'doc/output'
+end
 
 task :verify_env_vars do
   raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
   raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
 end
 
-task :publish_doc => [:rdoc] do
-  publisher = Rake::RubyForgePublisher.new(PKG_NAME, ENV['RUBYFORGE_USER'])
+desc "Upload Website to RubyForge"
+task :publish_website => [:doc, :rdoc, :rcov] do
+  publisher = Rake::SshDirPublisher.new(
+    "#{ENV['RUBYFORGE_USER']}@rubyforge.org",
+    "/var/www/gforge-projects/#{PKG_NAME}",
+    "doc/output"
+  )
+
   publisher.upload
 end
 
-desc "Release gem to RubyForge. MAKE SURE PKG_VERSION is aligned with the CHANGELOG file"
-task :release_files => [:gem] do
+desc "Release gem to RubyForge. You must make sure lib/version.rb is aligned with the CHANGELOG file"
+task :upload_releases => :package do
+
   release_files = FileList[
-    "pkg/#{PKG_FILE_NAME}.gem"
+    "pkg/#{PKG_FILE_NAME}.gem",
+    "pkg/#{PKG_FILE_NAME}.tgz",
+    "pkg/#{PKG_FILE_NAME}.zip"
   ]
 
   Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PKG_NAME)) do |xf|
@@ -167,11 +177,7 @@ task :release_files => [:gem] do
 end
 
 desc "Publish news on RubyForge"
-task :publish_news => [:gem] do
-  release_files = FileList[
-    "pkg/#{PKG_FILE_NAME}.gem"
-  ]
-
+task :publish_news do
   Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new(PKG_NAME)) do |news|
     # Never hardcode user name and password in the Rakefile!
     news.user_name = ENV['RUBYFORGE_USER']

data/bin/spec

@@ -1,10 +1,5 @@
 #!/usr/bin/env ruby
 
-if ARGV.empty?
-  puts "You must provide a directory or file to run"
-  exit
-end
-
 require 'find'
 require File.dirname(__FILE__) + "/../lib/spec"
 

data/doc/README

@@ -0,0 +1,5 @@
+The website can be generated with
+  webgen
+(Install the following gems: webgen, redcloth, bluecloth)
+
+TODO: write rake task that will generate website, put rdoc underneath it and upload everyhing.

data/doc/config.yaml

@@ -0,0 +1,2 @@
+# Configuration file for webgen
+# Used to set the parameters of the plugins

data/doc/plugin/syntax.rb

@@ -0,0 +1,38 @@
+module Tags
+  # gem install syntax
+  require 'syntax/convertors/html'
+
+  # prints out nicely formatted ruby code in html
+  class RubyInliner < DefaultTag
+    summary "renders a ruby file in html and inserts it"
+    depends_on "Tags"
+    add_param 'filename', nil, 'The File to insert'
+    set_mandatory 'filename', true
+    
+    CONVERTOR = Syntax::Convertors::HTML.for_syntax "ruby"
+    
+    def initialize
+      super
+      register_tag( 'ruby_inline')
+    end
+
+    def process_tag(tag, node, ref_node)
+      content = ''
+      begin
+				filename = get_param('filename')
+				if !File.exists?(filename)
+					if filename[0...1] == "~"
+						filename = File.expand_path(filename)
+					else
+						filename = ref_node.parent.recursive_value( 'src' ) + get_param( 'filename' )
+					end
+				end
+        self.logger.debug { "File location: <#{filename}>" }
+        content = File.read( filename )
+      rescue
+        self.logger.error { "Given file <#{filename}> does not exist (tag specified in <#{ref_node.recursive_value( 'src' )}>" }
+      end
+      CONVERTOR.convert(content)
+    end
+  end
+end

data/doc/src/community.page

@@ -0,0 +1,8 @@
+---
+title: Community
+inMenu: true
+ordering: 5
+---
+h2. Community
+
+Mailing lists, Issue tracker, How to send patches etc.

data/doc/src/default.css

@@ -0,0 +1,198 @@
+/* CSS Document by JM (ISeeYou-Designs.com) */
+
+body {
+	background-color:#fff;
+	font-family:"Trebuchet MS",arial,sans-serif;
+	font-size:62.5%;
+	color:#777;
+	margin:0;
+	padding:0;
+}
+a {
+	text-decoration:none;
+	color:#222;
+}
+a:hover {
+	color:#c00;
+}
+acronym {
+	cursor:help;
+	border-bottom:1px dotted #ddd;
+}
+#container {
+	font-size:1.2em;
+	width:550px;
+	margin:0 auto;
+	border-right:3px double #000;
+}
+#header {
+	color:#444;
+	margin:0;
+	padding:10px;
+	background:#fff url(business_card.jpg) no-repeat bottom right;
+}
+#header h1 {
+	font-family:"Trebuchet MS",arial,sans-serif;
+	font-size:2em;
+	color:#333;
+	margin:0;
+	font-weight:normal;
+}
+#header h1 strong {
+	color:#c00;
+}
+
+#header h2 {
+	margin:140px 0 0 0;
+	font-size:1em;
+	font-weight:normal;
+	color:#999;
+}
+#header h2 strong {
+	color:#c00;
+}
+#navigation {
+	text-align:right;
+	margin:10px 10px 10px auto;
+}
+#navigation {
+	margin:0 10px 0 0;
+	padding:0;
+}
+#navigation li {
+	margin:0;
+	padding:0;
+	list-style:none;
+	display:inline;
+}
+
+#navigation li a {
+	padding:5px 5px 2px 5px;
+	margin:0 1px 0 1px;
+	color:#666;
+	text-decoration:none;
+	font-weight:bold;
+	border-bottom:1px solid #c00;
+}
+
+#navigation li a:hover {
+	color:#C00;
+	border-bottom:1px solid #ddd;
+}
+#content {
+	margin:20px 0 20px 10px;
+	padding:0;
+}
+#content p {
+	padding:2px 20px;
+	text-align:justify;
+	text-indent:0.5cm;
+	line-height:1.8em;
+}
+#content h1 {
+	display:block;
+	margin:50px 0 0 10px;
+	padding:0;
+	font-family:"Trebuchet MS",arial,sans-serif;
+	font-size:1.8em;
+	color:#c00;
+	border-color:#ddd;
+	border-style:solid;
+	border-width:0 0 1px 0;
+}
+#content h2 {
+	display:block;
+	margin:20px 0 0 30px;
+	padding:0;
+	font-family:"Trebuchet MS",arial,sans-serif;
+	font-size:1.1em;
+	letter-spacing:2px;
+	color:#444;
+	border-color:#c00;
+	border-style:solid;
+	border-width:0 0 1px 0;
+}
+#content .post_info {
+	text-align:right;
+	margin:0 25px 5px 25px;
+	padding:2px;
+	font-size:0.8em;
+	font-family:arial,sans-serif;
+	color:#aaa;
+	line-height:0.9em;
+	word-spacing:1px;
+	border-top:1px solid #ddd;
+}
+#content .post_info a {
+	text-transform:uppercase;
+}
+#content blockquote {
+	margin:10px 60px;
+	padding:5px;
+	font-family:"Trebuchet MS",arial,sans-serif;
+	font-size:0.9em;
+	color:#444;
+	border:1px solid #ddd;
+	background-color:#eee;
+}
+#content blockquote p {
+	margin:0;
+	padding:0;
+	text-indent:0;
+}
+#content pre {
+	margin:10px 60px;
+	padding:5px;
+	color:#444;
+	border:1px solid #eee;
+	background-color:#fafafa;
+}
+#content ul {
+	margin-left:70px;
+	list-style:upper-roman outside;
+	font-family:arial,sans-serif;
+	font-size:0.9em;
+}
+#content li {
+	padding:3px;
+}
+#footer {
+	font-size:0.9em;
+	font-family:arial,sans-serif;
+	margin:90px 0 20px 0;
+	padding:5px;
+	border-top:1px solid #c00;
+}
+#footer p {
+	text-align:right;
+	line-height:1.1em;
+	color:#bbb;
+	font-size:0.9em;
+	font-family:arial,sans-serif;
+	margin:0;
+	padding:0;
+}
+#footer span {
+	color:#888;
+}
+#footer a {
+	color:#888;
+}
+#footer a:hover {
+	color:#aaa;
+}
+
+/* Ruby code */
+pre {
+	font-size: 12px;
+}
+.keyword { font-family: monospace; color: #8B0000; }
+.constant, .attribute, .global, .class, .module { font-family: monospace; color: black;}
+.string { font-family: monospace; color: #00008B; }
+.ident, .method { font-family: monospace; color: #006400; }
+.number, .char { font-family: monospace; color: #888800; }
+.comment { font-family: monospace; color: purple; }
+.symbol { font-family: monospace; color: #884400; }
+.regex { font-family: monospace; color: #808080; }
+.punct { font-family: monospace; color: black; }
+.escape, .interp, .expr { font-family: monospace; color: black; background-color: #dddddd; }

data/doc/src/default.template

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang:}">
+  <head>
+    <title>{title: }</title>
+    <link href="{relocatable: default.css}" rel="stylesheet" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  </head>
+<body>
+
+<div id="container">
+	<div id="header">
+        <h2>Behaviour Driven Development for <strong>Ruby</strong></h2>
+		<h1>RSpec</h1>
+	</div>
+
+	<div id="navigation">
+	    <!-- Not sure how to get this in the menu -->
+	    <a href="rdoc/index.html">RDoc</a>
+	    <a href="coverage/index.html">RCov</a>
+		{menu: }
+	</div>
+
+	<div id="content">
+		{content: }
+		
+		<div id="footer">
+			Webdesign by <a href="http://www.oswd.org/user/profile/id/9462">JM</a>
+		</div>
+	</div>
+</div>
+
+</body>
+</html>