rspec 0.5.1 → 0.5.2

data/CHANGES

@@ -1,5 +1,12 @@
 = RSpec Changelog
 
+== Version 0.5.2
+This release has minor improvements to the commandline and fixes some gem warnings
+
+* Readded README to avoid RDoc warnings [aslak_hellesoy]
+* Added --version switch to commandline [aslak_hellesoy]
+* More changes to the mock API [dastels], [dchelimsky]
+
 == Version 0.5.1
 This release is the first release of RSpec with a new website. It will look better soon.
 
@@ -7,7 +14,8 @@ This release is the first release of RSpec with a new website. It will look bett
 * 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]
+* Various changes to the mock API [dastels], [dchelimsky]
+* Various improvements to failure reporting [dchelimsky]
 
 == Version 0.5.0
 

data/README

@@ -0,0 +1 @@
+See http://rspec.rubyforge.org

data/Rakefile

@@ -136,19 +136,27 @@ task :clobber do
   rm_rf 'doc/output'
 end
 
-task :release => [:clobber, :test, :verify_env_vars, :upload_releases, :publish_website, :publish_news]
+task :release => [:clobber, :verify_user, :verify_password, :test, :upload_releases, :publish_website, :publish_news]
 
-task :rcov do
+desc "Build the website with rdoc and rcov, but do not publish it"
+task :website => [:clobber, :test, :doc, :rdoc, :rcov]
+
+task :rcov => [:test] do
+  rm_rf 'doc/output/coverage'
+  mkdir 'doc/output' unless File.exists? 'doc/output'
   mv 'coverage', 'doc/output'
 end
 
-task :verify_env_vars do
+task :verify_user do
   raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+end
+
+task :verify_password do
   raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
 end
 
 desc "Upload Website to RubyForge"
-task :publish_website => [:doc, :rdoc, :rcov] do
+task :publish_website => [:verify_user, :website] do
   publisher = Rake::SshDirPublisher.new(
     "#{ENV['RUBYFORGE_USER']}@rubyforge.org",
     "/var/www/gforge-projects/#{PKG_NAME}",
@@ -159,7 +167,7 @@ task :publish_website => [:doc, :rdoc, :rcov] do
 end
 
 desc "Release gem to RubyForge. You must make sure lib/version.rb is aligned with the CHANGELOG file"
-task :upload_releases => :package do
+task :upload_releases => [:verify_user, :verify_password, :package] do
 
   release_files = FileList[
     "pkg/#{PKG_FILE_NAME}.gem",
@@ -177,7 +185,7 @@ task :upload_releases => :package do
 end
 
 desc "Publish news on RubyForge"
-task :publish_news do
+task :publish_news => [:verify_user, :verify_password] 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/doc/README

@@ -2,4 +2,4 @@ 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.
+TODO: write rake task that will generate website, put rdoc underneath it and upload everything.

data/doc/src/community.page

@@ -1,7 +1,6 @@
 ---
 title: Community
 inMenu: true
-ordering: 5
 ---
 h2. Community
 

data/doc/src/default.template

@@ -16,9 +16,7 @@
 
 	<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: }
+	    {menu: {menuStyle: horizontal}}
 	</div>
 
 	<div id="content">

data/doc/src/documentation/api.page

@@ -9,7 +9,7 @@ When RSpec executes specifications, it defines a method *should* on every object
 This *should* method is your entry to the magic of RSpec.
 
 Almost all expectation forms have a corresponding negated form. It is listed
-when it is supported and is met when ever the non negated form would be
+when it is supported and, in general, is met when ever the non negated form would be
 violated.
 
 h3. General
@@ -23,9 +23,9 @@ target.should.not.satisfy {|arg| ...}
 </code>
 </pre>
 
-The supplied block is evaluated, passing target as the sole argument. If the
-block evaluates to false in the case of should.satisfy, or true in the case of
-should.not.satisfy, ExpectationNotMetError is raised.
+The supplied block is evaluated, passing <code>target</code> as the sole argument. If the
+block evaluates to <code>false</code> in the case of <code>should.satisfy</code>, or <code>true</code> in the case of
+<code>should.not.satisfy</code>, <code>ExpectationNotMetError</code> is raised.
 
 <pre>
 <code>
@@ -34,6 +34,7 @@ target.should.satisfy {|arg| arg > 0}
 </pre>
 
 h4. Equality
+
 <pre>
 <code>
 target.should.equal <value>
@@ -41,8 +42,8 @@ target.should.not.equal <value>
 </code>
 </pre>
 
-The target object is compared to <value> using ==. If the result is false (or
-true for the negated form) ExpectationNotMetError is raised.
+The target object is compared to <code>value</code> using ==. If the result is <code>false</code> (or
+<code>true</code> for the negated form) <code>ExpectationNotMetError</code> is raised.
 
 h4. Floating Point Comparison
 
@@ -53,9 +54,9 @@ target.should.not.be.close <value>, <tolerance>
 </code>
 </pre>
 
-The target object is compared to <value>. In the former case, if they differ
-by more that <tolerance> ExpectationNotMetError is raised. In the latter case,
-it is raised if they differ by less than <tolerance>.
+The target object is compared to <code>value</code>. In the former case, if they differ
+by more that <code>tolerance</code> <code>ExpectationNotMetError</code> is raised. In the latter case,
+it is raised if they differ by less than <code>tolerance</code>.
 
 <pre>
 <code>
@@ -72,8 +73,8 @@ target.should.not.be <value>
 </code>
 </pre>
 
-The target object is compared to <value> using equal?. If the result is false
-(or true for the negated form) ExpectationNotMetError is raised.
+The target object is compared to <code>value</code> using <code>equal?</code>. If the result is <code>false</code>
+(or <code>true</code> for the negated form) <code>ExpectationNotMetError</code> is raised.
 
 h4. Arbitrary Predicate
 
@@ -87,14 +88,14 @@ target.should.not.be.predicate [optional args]
 </code>
 </pre>
 
-The message predicate? is sent to target with any supplied arguments. If the
-result is false (or true for the negated form) ExpectationNotMetError is
+The message <code>predicate?</code> is sent to <code>target</code> with any supplied arguments. If the
+result is <code>false</code> (or <code>true</code> for the negated form) <code>ExpectationNotMetError</code> is
 raised.
 
 <pre>
 <code>
-container.should.include 'a' uses container.include? 'a'
-container.should.be.empty uses container.empty?
+container.should.include 'a' => container.include? 'a'
+container.should.be.empty => container.empty?
 </code>
 </pre>
 
@@ -107,7 +108,7 @@ target.should.not.match <regex>
 </code>
 </pre>
 
-The target is matched against <regex>. An ExpectationNotMetError is raised if
+The <code>target</code> is matched against <code>regex</code>. An <code>ExpectationNotMetError</code> is raised if
 the match fails or succeeds, respectively.
 
 h3. Class/Type
@@ -121,9 +122,9 @@ target.should.not.be.an.instance.of <class>
 </code>
 </pre>
 
-An ExpectationNotMetError is raised if target is not or is, respectively, an
-direct instance of <class>. As expected this correlates to target.instance_of?
-<class>.
+An <code>ExpectationNotMetError</code> is raised if <code>target</code> is not or is, respectively, an
+direct instance of <code>class</code>. As expected this correlates to <code>target.instance_of?
+ class</code>.
 
 h4. Ancestor Class
 
@@ -134,8 +135,8 @@ target.should.not.be.a.kind.of <class>
 </code>
 </pre>
 
-As above, but uses target.kind_of? <class>: checking whether <class> is the
-direct class of target, or an ancestor of target's class.
+As above, but uses <code>target.kind_of? class</code>: checking whether <code>class</code> is the
+direct class of <code>target</code>, or an ancestor of <code>target</code>'s class.
 
 h4. Type
 
@@ -146,8 +147,8 @@ target.should.not.respond.to <symbol>
 </code>
 </pre>
 
-Uses target.respond_to? <symbol> to check whether <symbol> is the name of a
-message that target understands.
+Uses <code>target.respond_to? symbol?</code> to check whether <code>symbol</code> is the name of a
+message that <code>target</code> understands.
 
 h3. Procs
 
@@ -160,8 +161,8 @@ proc.should.not.raise <exception>
 </code>
 </pre>
 
-Checks that proc does or doesn't cause the named exception to be raised.
-Typically the proc is created in place using lambda. For example:
+Checks that <code>proc</code> does or doesn't cause the named exception to be raised.
+Typically the <code>proc</code> is created in place using <code>lambda</code>. For example:
 
 <pre>
 <code>
@@ -190,7 +191,7 @@ proc.should.not.throw <symbol>
 </code>
 </pre>
 
-Similar to the above, but checks that <symbol> is thrown from within proc, or
+Similar to the above, but checks that <code>symbol</code> is thrown from within <code>proc</code>, or
 that it is not. The latter is actually one of two cases: some other symbol is
 thrown, or no symbol is thrown.
 
@@ -200,7 +201,7 @@ proc.should.not.throw
 </code>
 </pre>
 
-This form is more specific.  It checks that no symbol is thrown from within proc.
+This form is more specific.  It checks that no symbol is thrown from within <code>proc</code>.
 
 h3. Collections
 
@@ -213,14 +214,14 @@ target.should.include <object>
 </pre>
 
 This is simply a specific case of the arbitrary predicate form. It uses
-target.include? <object> and raises an ExpectationNotMetError if that returns
+<code>target.include? object</code> and raises an <code>ExpectationNotMetError</code> if that returns
 false. The remaining collection forms are a little more involved. They rely on
-two things: target responds to the message <things> by returning an object
-that responds to either length or size, which return a number that is a
-measure of size. Currently length is used if is appropriate, otherwise size is
+two things: <code>target</code> responds to the message <code>things</code> by returning an object
+that responds to either <code>length</code> or <code>size</code>, which return a number that is a
+measure of size. Currently <code>length</code> is used if is appropriate, otherwise <code>size</code> is
 attempted.
 
-4. Exact Size
+h4. Exact Size
 
 <pre>
 <code>
@@ -228,7 +229,7 @@ target.should.have(<number>).<things>
 </code>
 </pre>
 
-The <things> of target has a length/size of exactly <number>. 
+The <code>things</code> of <code>target</code> has a length/size of exactly <code>number</code>. 
 
 h4. Lower Bound
 
@@ -238,7 +239,7 @@ target.should.have.at.least(<number>).<things>
 </code>
 </pre>
 
-The <things> of target has a length/size of no less than <number>.
+The <code>things</code> of <code>target</code> has a length/size of no less than <code>number</code>.
 
 h4. Upper Bound
 
@@ -248,4 +249,4 @@ target.should.have.at.most(<number>).<things>
 </code>
 </pre>
 
-The <things> of target has a length/size of no more than <number>.
+The <code>things</code> of <code>target</code> has a length/size of no more than <code>number</code>.

data/doc/src/documentation/index.page

@@ -1,8 +1,13 @@
 ---
-title: Documentation
+title: Writing Specifications
 inMenu: true
-ordering: 1
 ---
-h2. Documentation
+h2. Writing Specifications
 
-Here is all the doco
+An RSpec specification is a Ruby file with a context and one or more specifications. Example:
+
+{ruby_inline: {filename: ../examples/empty_stack_spec.rb}}
+  
+A context represents a collection of specifications and must be defined with a name and a block (do-end).
+A specification is defined with the *specify* keyword and a sentence describing what's being specified.
+It is highly recommended to include

data/doc/src/documentation/meta.info

@@ -0,0 +1,22 @@
+index.page:
+  orderInfo: 10
+  
+api.page:
+  orderInfo: 11
+  
+mocks.page:
+  orderInfo: 12
+  
+rdoc.html:
+  title: RDoc
+  dest: ../rdoc/index.html
+  inMenu: true
+  orderInfo: 13
+
+rcov.html:
+  title: RCov
+  dest: ../coverage/index.html
+  inMenu: true
+  orderInfo: 14
+
+  

data/doc/src/documentation/mocks.page

@@ -1,7 +1,6 @@
 ---
 title: Mock API
 inMenu: true
-ordering: 5
 ---
 h2. Mock API
 
@@ -25,8 +24,8 @@ mock(<name>, <options>)
 </pre>
 
 As above, but allows you to specific options to tweak the mock's behaviour.
-The <options> argument is a hash. Currently the only supported option is
-:null_object. Setting this to true (i.e. :null_object => true) instructs the
+The <code>options</code> argument is a hash. Currently the only supported option is
+<code>:null_object</code>. Setting this to true (i.e. <code>:null_object => true</code>) instructs the
 mock to ignore (quietly consume) any messages it hasn't been told to expect.
 
 h3. Expecting Messages
@@ -37,7 +36,7 @@ mock.should.receive(<message>)
 </code>
 </pre>
 
-The <message> argument is a symbol that is the name of a message that you want
+The <code>message</code> argument is a symbol that is the name of a message that you want
 the mock to be expecting.
 
 h3. Arbitrary Message Receive Handling
@@ -63,12 +62,12 @@ mock.should.receive(:msg).with(1, 2, 3)
 </code>
 </pre>
 
-The <args> argument is a series of arguments (e..g. 1, 2, 3) that are expected
+The <code>args</code> argument is a series of arguments (e..g. 1, 2, 3) that are expected
 to be passed as arguments to the associated message.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing)
+mock.should.receive(:msg).with(:no_args)
 </code>
 </pre>
 
@@ -76,32 +75,63 @@ No arguments are to be accepted by the message.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:anything)
+mock.should.receive(:msg).with(:any_args)
 </code>
 </pre>
 
-Any arguments are to be accepted by the message. Additionally, constraints can
-be placed on individual arguments which are looser than value equivalence.
+Any arguments are to be accepted by the message. This includes cases where no
+arguments are provided. *This is the default when no <code>with()</code> clause is
+specified.*  Even so, sometimes you want to be explicit about it.
+
+h3. Argument Constraints
+
+Constraints can be placed on individual arguments which are looser than value equivalence.
+
+h4. :anything
+
+accepts any value for this argument
 
 <pre>
 <code>
-:anything
+mock.should.receive(:msg).with(1, :anything, "A")
 </code>
 </pre>
 
-accepts any value for this argument
+h4. :numeric
+
+accepts any numeric value for this argument
 
 <pre>
 <code>
-mock.should.receive(:msg).with(1, :anything, "A")
+mock.should.receive(:msg).with(a, :numeric, "b")
+</code>
+</pre>
+
+h4. :boolean
+
+accepts a boolean value for this argument
+
+<pre>
+<code>
+mock.should.receive(:msg).with(a, :boolean, "b")
 </code>
 </pre>
 
+h4. :string
+
+accepts any string for this argument
+
+<pre>
+<code>
+mock.should.receive(:msg).with(a, :string, "b")
+</code>
+</pre>
+	
 h3. Receive Counts
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).never
+mock.should.receive(:msg).never
 </code>
 </pre>
 
@@ -109,7 +139,7 @@ A problem is reported if the message is ever received.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).any.number.of.times
+mock.should.receive(:msg).any.number.of.times
 </code>
 </pre>
 
@@ -117,7 +147,7 @@ The message can be received 0 or more times.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).once
+mock.should.receive(:msg).once
 </code>
 </pre>
 
@@ -126,7 +156,7 @@ than once.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).twice
+mock.should.receive(:msg).twice
 </code>
 </pre>
 
@@ -134,7 +164,7 @@ A problem is reported is the message is received anything but two times.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).exactly(n).times
+mock.should.receive(:msg).exactly(n).times
 </code>
 </pre>
 
@@ -142,7 +172,7 @@ A problem is reported is the message is received anything but n times.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).at.least(:once)
+mock.should.receive(:msg).at.least(:once)
 </code>
 </pre>
 
@@ -150,7 +180,7 @@ A problem is reported if the message is never received.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).at.least(:twice)
+mock.should.receive(:msg).at.least(:twice)
 </code>
 </pre>
 
@@ -158,7 +188,7 @@ A problem is reported is the message is never received or is received only once.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).at.least(n).times
+mock.should.receive(:msg).at.least(n).times
 </code>
 </pre>
 
@@ -168,40 +198,46 @@ h3. Return Values
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).once.and.return(<value>)
+mock.should.receive(:msg).once.and.return(<value>)
 </code>
 </pre>
 
-When the expected message is received, <value> will be returned as the result.
+When the expected message is received, <code>value</code> will be returned as the result.
 
 <pre>
 <code>
-and.return([<value1>, <value2>, …, <valuen>])
-mock.should.receive(:msg).with(:nothing).once.and.return(1, 2, 3)
+and.return([<value-1>, <value-2>, ..., <value-n>])
 </code>
 </pre>
 
-When the expected message is received, <valuei> will be returned as the result
-for the ith reception of the message. Once i > n, <valuen> is returned for all
+When the expected message is received, <code>value-i</code> will be returned as the result
+for the ith reception of the message. Once i > n, <code>value-n</code> is returned for all
 subsequent receives of the message.
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:nothing).once.and.return {…} 
-mock.should.receive(:msg).with(:anything).once.and.return {|a, b| a + b}
+mock.should.receive(:msg).once.and.return {...} 
 </code>
 </pre>
 
 When the expected message is received, the result of evaluating the supplied
 block will be returned as the result. The block is passed any arguments passed
 as parts of the message. This capability can be used to compute return values
-based on the arguments.
+based on the arguments.  For example:
+
+<pre>
+<code>
+mock.should.receive(:msg).once.and.return {|a, b| a + b}
+</code>
+</pre>
+
+h3. Raising and Throwing
 
 <pre>
 <code>
-mock.should.receive(:msg).with(:anything).once.and.throw(<symbol>) 
-mock.should.receive(:msg).with(:anything).once.and.raise(<exception>)
+mock.should.receive(:msg).once.and.raise(<exception>)
+mock.should.receive(:msg).once.and.throw(<symbol>) 
 </code>
 </pre>
 
-These instruct the mock to raise an exception or throw a symbol instead of returning a value.on other objects.
+These instruct the mock to raise an exception or throw a symbol instead of returning a value.