test-unit-mock 0.30

data/COPYING

@@ -0,0 +1,58 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/ChangeLog

@@ -0,0 +1,262 @@
+2003-10-01 09:11  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.10):
+
+	- Added #respond_to? to UnmockedMethods. Thanks to Samuel Tesla
+	  <samuel@alieniloquent.com> for the bug report and patch.
+	
+2003-10-01 09:10  Michael Granger <ged@FaerieMUD.org>
+
+	* test.rb (1.5):
+
+	- Added better add{setup,teardown}Block mechanics
+	
+	- Added tests for UnmockedMethods
+	
+2003-05-31 13:26  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.9, RELEASE_0_02):
+
+	- Moved the regex that matches unmocked methods into a constant and //x'ed it,
+	  as it was becoming unwieldy and/or unreadable.
+	
+	- Added an is_a? alias for the faked kind_of?.
+	
+2003-05-12 12:42  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/template/html/mues.rb (1.6):
+
+	- Fixed XHTML validity by adding missing </td>.
+	
+	- Updated copyright dates.
+	
+2003-03-05 13:44  Michael Granger <ged@FaerieMUD.org>
+
+	* misc/readmecode.rb (1.2, RELEASE_0_02):
+
+	- Wrapped the callTrace for each test in a $DEBUG block.
+	
+2003-03-05 13:43  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.8):
+
+	- New method: fullStackTrace().
+	
+2003-03-05 13:35  Michael Granger <ged@FaerieMUD.org>
+
+	* README (1.3, RELEASE_0_02):
+
+	- Added example usage of the #callTrace method.
+	
+	- Added example of using MockObject() factory method for a superclass.
+	
+2003-03-04 17:07  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/makesitedocs.rb (1.2, RELEASE_0_02):
+
+	Updated upload URL
+	
+2003-03-04 16:44  Michael Granger <ged@FaerieMUD.org>
+
+	* COPYING (1.1), makedist.rb (1.1) (utags: RELEASE_0_02,
+	RELEASE_0_01):
+
+	Initial commit.
+	
+2003-03-04 16:42  Michael Granger <ged@FaerieMUD.org>
+
+	* README (1.2, RELEASE_0_01):
+
+	- Modified documentation instructions to not requires the docs/ directory, which
+	  won't be in the distribution.
+	
+2003-03-04 16:39  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.7, RELEASE_0_01):
+
+	- Updated, clarified, and corrected documentation.
+	
+	- Made calls to #verify use Test::Unit::Assertions.
+	
+	- Fixed bug in __makeCallOrderFailMsg() that manifested when @callOrder
+	  contained more entries than @calls.
+	
+	- Removed unnecessary arguments to super() in the generated mock methods.
+	
+2003-03-04 16:35  Michael Granger <ged@FaerieMUD.org>
+
+	* test.rb (1.4, RELEASE_0_02, RELEASE_0_01):
+
+	- Made changes to requires to reflect reorganization of distro.
+	
+2003-03-04 16:35  Michael Granger <ged@FaerieMUD.org>
+
+	* utils.rb (1.2, RELEASE_0_02, RELEASE_0_01):
+
+	- Updated with changes from other modules.
+	
+2003-03-04 16:32  Michael Granger <ged@FaerieMUD.org>
+
+	* README (1.1), install.rb (1.1, RELEASE_0_02, RELEASE_0_01),
+	misc/readmecode.rb (1.1, RELEASE_0_01), docs/.cvsignore (1.1,
+	RELEASE_0_02, RELEASE_0_01), docs/CATALOG (1.1, RELEASE_0_02,
+	RELEASE_0_01), docs/makedocs.rb (1.1, RELEASE_0_02, RELEASE_0_01),
+	docs/makesitedocs.rb (1.1, RELEASE_0_01):
+
+	Initial commit.
+	
+2003-03-04 10:52  Michael Granger <ged@FaerieMUD.org>
+
+	* test.rb (1.3):
+
+	- Added tests for double-underscored and non-camelCased methods.
+	
+2003-03-03 23:33  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.6):
+
+	- Fixed an accidentally-slashed <tt> in the RDocs.
+	
+2003-01-25 18:31  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.5):
+
+	- More documenation fixes.
+	
+2003-01-25 18:29  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.4):
+
+	- Documented usage of the MockObject method in a class definition.
+	
+	- Untabified literal/synopsis sections.
+	
+2003-01-25 18:09  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.3):
+
+	- Updated for newer versions of Ruby.
+	
+	- Prefixed internal methods for MockObject with '__' to avoid collision with
+	  actual methods.
+	
+	- Added block argument to mocked methods.
+	
+	- Added '#hash' to the list of methods not mocked.
+	
+2003-01-25 18:06  Michael Granger <ged@FaerieMUD.org>
+
+	* test.rb (1.2):
+
+	- Updated for newer versions of Ruby.
+	
+	- Updated for newer versions of Test::Unit.
+	
+2002-10-02 10:56  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.2):
+
+	- Finished up the comment header.
+	
+2002-10-02 03:03  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.1), test.rb (1.1), utils.rb (1.1):
+
+	Initial revision
+	
+2002-10-02 03:03  Michael Granger <ged@FaerieMUD.org>
+
+	* mock.rb (1.1.1.1), test.rb (1.1.1.1), utils.rb (1.1.1.1) (utags:
+	ALPHA_1_1):
+
+	Initial import
+	
+2002-09-12 03:55  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/: generators/html_generator.rb (1.3),
+	parsers/parse_faeriemud_rb.rb (1.2) (utags: RELEASE_0_02,
+	RELEASE_0_01):
+
+	- Initial stab at the :todo: hack. Not yet working.
+	
+2002-08-29 01:15  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/template/html/mues.rb (1.5,
+	RELEASE_0_01, RELEASE_0_02):
+
+	- Added the <br /> I mistakenly removed with the viewcvs commit back in.
+	
+2002-08-02 14:07  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/template/html/mues.rb (1.4):
+
+	- Added a link to the appropriate URL on cvs.FaerieMUD.org.
+	
+2002-07-07 12:16  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/template/html/css2.rb (1.1,
+	RELEASE_0_01, RELEASE_0_02):
+
+	Initial commit.
+	
+2002-06-04 06:56  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/faeriemud_generator.rb (1.3):
+
+	Renamed to html_generator.rb
+	
+2002-05-28 11:07  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/template/html/mues.rb (1.3):
+
+	- Renamed from faeriemud.rb
+	
+	- Converted to output XHTML.
+	
+	- Added comment header and other nicities in preparation for release.
+	
+2002-05-28 11:06  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/template/html/faeriemud.rb (1.3):
+
+	- Renamed to mues.rb.
+	
+2002-05-15 22:02  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/template/html/: faeriemud.rb (1.2),
+	mues.rb (1.2):
+
+	- Removed break in class header 'Last Updated' label.
+	
+2002-05-15 21:42  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/myhtml_generator.rb (1.3):
+
+	- Renamed to faeriemud_generator.rb in preparation for submitting to PragDave.
+	
+2002-05-15 21:40  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/generators/: faeriemud_generator.rb (1.2),
+	html_generator.rb (1.2), myhtml_generator.rb (1.2):
+
+	- Touched up comments
+	
+	- Added a missing require
+	
+2002-05-15 21:30  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/myparser.rb (1.2):
+
+	- Moved into docs/lib/rdoc/parsers/parse_faeriemud_rb.rb.
+	
+2002-03-30 12:01  Michael Granger <ged@FaerieMUD.org>
+
+	* docs/lib/rdoc/: myparser.rb (1.1),
+	generators/faeriemud_generator.rb (1.1),
+	generators/html_generator.rb (1.1), generators/myhtml_generator.rb
+	(1.1), generators/template/html/faeriemud.rb (1.1),
+	generators/template/html/mues.rb (1.1),
+	parsers/parse_faeriemud_rb.rb (1.1):
+
+	Initial commit.
+	

data/README

@@ -0,0 +1,203 @@
+
+= Test-Unit-Mock: A mock-object class for Test::Unit
+
+== Authors
+
+ Michael Granger <ged@FaerieMUD.org>
+
+
+== Description
+
+Test-Unit-Mock is a class for conveniently building mock objects in Test::Unit
+test cases. It is based on ideas in Ruby/Mock by Nat Pryce
+<nat.pryce@b13media.com>, which is a class for doing much the same thing for
+RUnit test cases.
+
+It allows you do make a mocked object that will respond to all the methods of
+the real class (albeit probably not with correct results) with one line of
+code. Eg.,
+
+  mockSocket = Test::Unit::MockObject( TCPSocket ).new
+
+You can then specify return values for the methods you wish to test in one of
+several different ways:
+
+  # Make the #addr method return three cycling values (which will be repeated
+  # when it reaches the end
+  mockSocket.setReturnValues( :addr => [
+      ["AF_INET", 23, "localhost", "127.0.0.1"],
+      ["AF_INET", 80, "slashdot.org", "66.35.250.150"],
+      ["AF_INET", 2401, "helium.ruby-lang.org", "210.251.121.214"],
+    ] )
+
+  # Make the #write and #read methods call a Proc and a Method, respectively
+  mockSocket.setReturnValues( :write => Proc::new {|str| str.length},
+                              :read => method(:fakeRead) )
+
+  # Set up the #getsockopt method to return a value based on the arguments
+  # given:
+  mockSocket.setReturnValues( :getsockopt => {
+      [Socket::SOL_TCP,    Socket::TCP_NODELAY] => [0].pack("i_"),
+      [Socket::SOL_SOCKET, Socket::SO_REUSEADDR] => [1].pack("i_"),
+    } )
+
+You can also set the order in which you expect methods to be called, but you
+don't have to do so if you don't care:
+
+  mockSocket.setCallOrder( :addr, :getsockopt, :write, :read, :write, :read )
+
+
+By default, when testing for call order, other method calls may be interspersed
+between the calls specified without effect, and only a missing or misordered method
+call causes the assertions to fail. If you want the call order to be adhered to
+strictly, you can set that:
+
+  mockSocket.strictCallOrder = true
+
+Then, when you're ready to test, just activate the object and send it off to
+whatever code you're testing:
+
+  mockSocket.activate
+  testedObject.setSocket( mockSocket )
+  ...
+
+  # Check method call order on the mocked socket (adds assertions)
+  mockSocket.verify
+
+Assertion failures contain a message that specifies exactly what went wrong,
+eg.:
+
+  $ ruby misc/readmecode.rb
+
+    1) Failure!!!
+  test_incorrectorder(MockTestExperiment) [./mock.rb:255]:
+  Call order assertion failed: Expected call to :write, but got call to :read 
+    from misc/readmecode.rb:77:in `test_incorrectorder' at 0.00045
+    instead
+
+    2) Failure!!!
+  test_missingcall(MockTestExperiment) [./mock.rb:255]:
+  Call order assertion failed: Missing call to :read.
+
+If you require more advanced functionality, you can also use the mocked object
+class as a superclass:
+
+   # Create a mock socket class
+   class MockSocket < Test::Unit::MockObject( TCPSocket )
+        def initialize
+            super
+            setCallOrder( :read, :read, :read, :write, :read )
+            strictCallOrder = true
+            @io = ''
+        end
+
+       def read( len )
+           super # Call the mocked method to record the call
+           rval = @io[0,len]
+           @io[0,len] = ''
+
+           return rval
+       end
+
+       def write( str )
+           super # Call the mocked method to record the call
+           @io += str
+           return str.length
+       end
+   end
+
+
+You can also add debugging to your tests to give you a timestamped history of
+each call:
+
+  # Call the methods in the correct order
+  mockSocket.addr
+  mockSocket.getsockopt( Socket::SOL_TCP, Socket::TCP_NODELAY )
+  mockSocket.write( "foo" )
+  mockSocket.read( 1024 )
+  mockSocket.write( "bar" )
+  mockSocket.read( 4096 )
+
+  # Check method call order on the mocked socket
+  mockSocket.verify
+
+  if $DEBUG
+    puts "Call trace:\n\t" + mockSocket.callTrace.join("\n\t")
+  end
+
+This outputs something like:
+
+  Call trace:
+    addr(  ) at 0.00015 seconds from misc/readmecode.rb:64:in `test'
+    getsockopt( 6,1 ) at 0.00030 seconds from misc/readmecode.rb:65:in `test'
+    write( "foo" ) at 0.00040 seconds from misc/readmecode.rb:66:in `test'
+    read( 1024 ) at 0.00050 seconds from misc/readmecode.rb:67:in `test'
+    write( "bar" ) at 0.00063 seconds from misc/readmecode.rb:68:in `test'
+    read( 4096 ) at 0.00072 seconds from misc/readmecode.rb:69:in `test'
+
+
+== More Information
+
+For more information about mock objects and unit testing, see:
+
+  <URL: http://www.sidewize.com/company/mockobjects.pdf>
+
+
+== Requirements
+
+  * Ruby >= 1.6.8 - Older versions have not been tested, but may work.
+    <URL: http://www.ruby-lang.org/en/>
+
+  * Test::Unit - Of course.
+    <URL: http://raa.ruby-lang.org/list.rhtml?name=testunit>
+
+  * The 'diff' library - Used to compare the call lists.
+    <URL: http://raa.ruby-lang.org/list.rhtml?name=diff>
+
+
+== Caveats
+
+This module, while simple, has not been extensively tested under environments
+other than my own (Linux). It has worked well for me, but your mileage may vary.
+
+I would greatly appreciate feedback on any aspect of this software. Suggestions,
+feature requests, questions, design critiques, and bug reports are most
+welcome. Relevant patches are particularly helpful. I may be reached at
+<ged@FaerieMUD.org>.
+
+
+== Installation
+
+To run the included test suite:
+
+  $ ruby test.rb
+
+To generate HTML documentation:
+
+  $ rdoc README mock.rb
+
+To install:
+
+  $ su
+  # ruby install.rb
+
+
+== Legal
+
+Test-Unit-Mock is Free Software which is Copyright (c) 2002,2003 by The
+FaerieMUD Consortium.
+
+You may use, modify, and/or redistribute this software under the terms of the
+Ruby License, a copy of which should have been included in this distribution
+(See the file COPYING). If it was not, a copy of it may be obtained online at
+http://www.ruby-lang.org/en/LICENSE.txt (English language) or
+http://www.ruby-lang.org/ja/LICENSE.txt (Japanese language).
+
+THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND
+FITNESS FOR A PARTICULAR PURPOSE.
+
+
+ $Id: README,v 1.3 2003/03/05 20:35:28 deveiant Exp $
+
+