flexmock 1.3.3 → 2.0.0.rc1

data/doc/examples/test_unit_examples_test.rb

@@ -0,0 +1,240 @@
+require 'flexmock/test_unit'
+
+class TestSimple < Test::Unit::TestCase
+
+  # Simple stubbing of some methods
+
+  def test_simple_mock
+    m = flexmock(:pi => 3.1416, :e => 2.71)
+    assert_equal 3.1416, m.pi
+    assert_equal 2.71, m.e
+  end
+end
+
+
+class TestUndefined < Test::Unit::TestCase
+
+  # Create a mock object that returns an undefined object for method calls
+
+  def test_undefined_values
+    m = flexmock("mock")
+    m.should_receive(:divide_by).with(0).
+      and_return_undefined
+    assert_equal FlexMock.undefined, m.divide_by(0)
+  end
+end
+
+class TestDb < Test::Unit::TestCase
+
+  # Expect multiple queries and a single update
+
+  # Multiple calls to the query method will be allows, and calls may
+  # have any argument list. Each call to query will return the three
+  # element array [1, 2, 3]. The call to update must have a specific
+  # argument of 5.
+
+  def test_db
+    db = flexmock('db')
+    db.should_receive(:query).and_return([1,2,3])
+    db.should_receive(:update).with(5).and_return(nil).once
+
+    # Test Code
+
+    db.query
+    db.update(5)
+  end
+end
+
+class TestOrdered < Test::Unit::TestCase
+
+  # Expect all queries before any updates
+
+  # All the query message must occur before any of the update
+  # messages.
+
+  def test_query_and_update
+    db = flexmock('db')
+    db.should_receive(:query).and_return([1,2,3]).ordered
+    db.should_receive(:update).and_return(nil).ordered
+
+    # test code here
+
+    db.query
+    db.update
+  end
+end
+
+class MoreOrdered < Test::Unit::TestCase
+
+  # Expect several queries with different parameters
+
+  # The queries should happen after startup but before finish. The
+  # queries themselves may happen in any order (because they are in
+  # the same order group). The first two queries should happen exactly
+  # once, but the third query (which matches any query call with a
+  # four character parameter) may be called multiple times (but at
+  # least once). Startup and finish must also happen exactly once.
+
+  # Also note that we use the <code>with</code> method to match
+  # different argument values to figure out what value to return.
+
+  def test_ordered_queries
+    db = flexmock('db')
+    db.should_receive(:startup).once.ordered
+    db.should_receive(:query).with("CPWR").and_return(12.3).
+      once.ordered(:queries)
+    db.should_receive(:query).with("MSFT").and_return(10.0).
+      once.ordered(:queries)
+    db.should_receive(:query).with(/^....$/).and_return(3.3).
+      at_least.once.ordered(:queries)
+    db.should_receive(:finish).once.ordered
+
+    # Test Code
+
+    db.startup
+    db.query("MSFT")
+    db.query("XYZY")
+    db.query("CPWR")
+    db.finish
+  end
+end
+
+class EvenMoreOrderedTest < Test::Unit::TestCase
+
+  # Same as above, but using the Record Mode interface
+
+  # The record mode interface offers much the same features as the
+  # <code>should_receive</code> interface introduced so far, but it
+  # allows the messages to be sent directly to a recording object
+  # rather than be specified indirectly using a symbol.
+
+
+  def test_ordered_queries_in_record_mode
+    db = flexmock('db')
+    db.should_expect do |rec|
+      rec.startup.once.ordered
+      rec.query("CPWR") { 12.3 }.once.ordered(:queries)
+      rec.query("MSFT") { 10.0 }.once.ordered(:queries)
+      rec.query(/^....$/) { 3.3 }.at_least.once.ordered(:queries)
+      rec.finish.once.ordered
+    end
+
+    # Test Code
+
+    db.startup
+    db.query("MSFT")
+    db.query("XYZY")
+    db.query("CPWR")
+    db.finish
+  end
+end
+
+class RecordedTest < Test::Unit::TestCase
+
+  # Using Record Mode to record a known, good algorithm for testing
+
+  # Record mode is nice when you have a known, good algorithm that can
+  # use a recording mock object to record the steps. Then you compare
+  # the execution of a new algorithm to behavior of the old using the
+  # recorded expectations in the mock. For this you probably want to
+  # put the recorder in _strict_ mode so that the recorded
+  # expectations use exact matching on argument lists, and strict
+  # ordering of the method calls.
+
+  # <b>Note:</b> This is most useful when there are no queries on the
+  # mock objects, because the query responses cannot be programmed
+  # into the recorder object.
+
+  def test_build_xml
+    builder = flexmock('builder')
+    builder.should_expect do |rec|
+      rec.should_be_strict
+      known_good_way_to_build_xml(rec)  # record the messages
+    end
+    new_way_to_build_xml(builder)       # compare to new way
+  end
+
+  def known_good_way_to_build_xml(builder)
+    builder.person
+  end
+
+  def new_way_to_build_xml(builder)
+    builder.person
+  end
+
+end
+
+class MultipleReturnValueTest < Test::Unit::TestCase
+
+  # Expect multiple calls, returning a different value each time
+
+  # Sometimes you need to return different values for each call to a
+  # mocked method. This example shifts values out of a list for this
+  # effect.
+
+  def test_multiple_gets
+    file = flexmock('file')
+    file.should_receive(:gets).with_no_args.
+      and_return("line 1\n", "line 2\n")
+
+    # test code here
+
+    file.gets                   # returns "line 1"
+    file.gets                   # returns "line 2"
+  end
+end
+
+class IgnoreUnimportantMessages < Test::Unit::TestCase
+
+  # Ignore uninteresting messages
+
+  # Generally you need to mock only those methods that return an
+  # interesting value or wish to assert were sent in a particular
+  # manner. Use the <code>should_ignore_missing</code> method to turn
+  # on missing method ignoring.
+
+  def test_an_important_message
+    m = flexmock('m')
+    m.should_receive(:an_important_message).and_return(1).once
+    m.should_ignore_missing
+
+    # Test Code
+
+    m.an_important_message
+    m.an_unimportant_message
+  end
+
+  # When <code>should_ignore_missing</code> is enabled, ignored
+  # missing methods will return an undefined object. Any operation on
+  # the undefined object will return the undefined object.
+
+end
+
+class PartialMockTest < Test::Unit::TestCase
+
+  # Mock just one method on an existing object
+
+  # The Portfolio class calculate the value of a set of stocks by
+  # talking to a quote service via a web service. Since we don't want
+  # to use a real web service in our unit tests, we will mock the
+  # quote service.
+
+  def test_portfolio_value
+    flexmock(QuoteService).new_instances do |m|
+      m.should_receive(:quote).and_return(100)
+    end
+    port = Portfolio.new
+    value = port.value     # Portfolio calls QuoteService.quote
+    assert_equal 100, value
+  end
+
+  class QuoteService
+  end
+
+  class Portfolio
+    def value
+      qs = QuoteService.new
+      qs.quote
+    end
+  end
+end

data/doc/jamis.rb

@@ -0,0 +1,591 @@
+module RDoc
+module Page
+
+FONTS = "\"Bitstream Vera Sans\", Verdana, Arial, Helvetica, sans-serif"
+
+STYLE = <<CSS
+a {
+  color: #00F;
+  text-decoration: none;
+}
+
+a:hover {
+  color: #77F;
+  text-decoration: underline;
+}
+
+body, td, p {
+  font-family: %fonts%;
+  background: #FFF;
+  color: #000;
+  margin: 0px;
+  font-size: small;
+}
+
+#content {
+  margin: 2em;
+}
+
+#description p {
+  margin-bottom: 0.5em;
+}
+
+.sectiontitle {
+  margin-top: 1em;
+  margin-bottom: 1em;
+  padding: 0.5em;
+  padding-left: 2em;
+  background: #005;
+  color: #FFF;
+  font-weight: bold;
+  border: 1px dotted black;
+}
+
+.attr-rw {
+  padding-left: 1em;
+  padding-right: 1em;
+  text-align: center;
+  color: #055;
+}
+
+.attr-name {
+  font-weight: bold;
+}
+
+.attr-desc {
+}
+
+.attr-value {
+  font-family: monospace;
+}
+
+.file-title-prefix {
+  font-size: large;
+}
+
+.file-title {
+  font-size: large;
+  font-weight: bold;
+  background: #005;
+  color: #FFF;
+}
+
+.banner {
+  background: #005;
+  color: #FFF;
+  border: 1px solid black;
+  padding: 1em;
+}
+
+.banner td {
+  background: transparent;
+  color: #FFF;
+}
+
+h1 a, h2 a, .sectiontitle a, .banner a {
+  color: #FF0;
+}
+
+h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover {
+  color: #FF7;
+}
+
+.dyn-source {
+  display: none;
+  background: #FFE;
+  color: #000;
+  border: 1px dotted black;
+  margin: 0.5em 2em 0.5em 2em;
+  padding: 0.5em;
+}
+
+.dyn-source .cmt {
+  color: #00F;
+  font-style: italic;
+}
+
+.dyn-source .kw {
+  color: #070;
+  font-weight: bold;
+}
+
+.method {
+  margin-left: 1em;
+  margin-right: 1em;
+  margin-bottom: 1em;
+}
+
+.description pre {
+  padding: 0.5em;
+  border: 1px dotted black;
+  background: #FFE;
+}
+
+.method .title {
+  font-family: monospace;
+  font-size: large;
+  border-bottom: 1px dashed black;
+  margin-bottom: 0.3em;
+  padding-bottom: 0.1em;
+}
+
+.method .description, .method .sourcecode {
+  margin-left: 1em;
+}
+
+.description p, .sourcecode p {
+  margin-bottom: 0.5em;
+}
+
+.method .sourcecode p.source-link {
+  text-indent: 0em;
+  margin-top: 0.5em;
+}
+
+.method .aka {
+  margin-top: 0.3em;
+  margin-left: 1em;
+  font-style: italic;
+  text-indent: 2em;
+}
+
+h1 {
+  padding: 1em;
+  border: 1px solid black;
+  font-size: x-large;
+  font-weight: bold;
+  color: #FFF;
+  background: #007;
+}
+
+h2 {
+  padding: 0.5em 1em 0.5em 1em;
+  border: 1px solid black;
+  font-size: large;
+  font-weight: bold;
+  color: #FFF;
+  background: #009;
+}
+
+h3, h4, h5, h6 {
+  padding: 0.2em 1em 0.2em 1em;
+  border: 1px dashed black;
+  color: #000;
+  background: #AAF;
+}
+
+.sourcecode > pre {
+  padding: 0.5em;
+  border: 1px dotted black;
+  background: #FFE;
+}
+
+CSS
+
+XHTML_PREAMBLE = %{<?xml version="1.0" encoding="%charset%"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+}
+
+HEADER = XHTML_PREAMBLE + <<ENDHEADER
+<html>
+  <head>
+    <title>%title%</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <link rel="stylesheet" href="%style_url%" type="text/css" media="screen" />
+
+    <script language="JavaScript" type="text/javascript">
+    // <![CDATA[
+
+        function toggleSource( id )
+        {
+          var elem
+          var link
+
+          if( document.getElementById )
+          {
+            elem = document.getElementById( id )
+            link = document.getElementById( "l_" + id )
+          }
+          else if ( document.all )
+          {
+            elem = eval( "document.all." + id )
+            link = eval( "document.all.l_" + id )
+          }
+          else
+            return false;
+
+          if( elem.style.display == "block" )
+          {
+            elem.style.display = "none"
+            link.innerHTML = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
+        }
+      // ]]>
+    </script>
+  </head>
+
+  <body>
+ENDHEADER
+
+FILE_PAGE = <<HTML
+<table border='0' cellpadding='0' cellspacing='0' width="100%" class='banner'>
+  <tr><td>
+    <table width="100%" border='0' cellpadding='0' cellspacing='0'><tr>
+      <td class="file-title" colspan="2"><span class="file-title-prefix">File</span><br />%short_name%</td>
+      <td align="right">
+        <table border='0' cellspacing="0" cellpadding="2">
+          <tr>
+            <td>Path:</td>
+            <td>%full_path%
+IF:cvsurl
+				&nbsp;(<a href="%cvsurl%">CVS</a>)
+ENDIF:cvsurl
+            </td>
+          </tr>
+          <tr>
+            <td>Modified:</td>
+            <td>%dtm_modified%</td>
+          </tr>
+        </table>
+      </td></tr>
+    </table>
+  </td></tr>
+</table><br>
+HTML
+
+###################################################################
+
+CLASS_PAGE = <<HTML
+<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
+  <td class="file-title"><span class="file-title-prefix">%classmod%</span><br />%full_name%</td>
+  <td align="right">
+    <table cellspacing=0 cellpadding=2>
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+START:infiles
+HREF:full_path_url:full_path:
+IF:cvsurl
+&nbsp;(<a href="%cvsurl%">CVS</a>)
+ENDIF:cvsurl
+END:infiles
+        </td>
+      </tr>
+IF:parent
+    <tr>
+      <td>Parent:</td>
+      <td>
+IF:par_url
+        <a href="%par_url%">
+ENDIF:par_url
+%parent%
+IF:par_url
+         </a>
+ENDIF:par_url
+     </td>
+   </tr>
+ENDIF:parent
+         </table>
+        </td>
+        </tr>
+      </table>
+HTML
+
+###################################################################
+
+METHOD_LIST = <<HTML
+  <div id="content">
+IF:diagram
+  <table cellpadding='0' cellspacing='0' border='0' width="100%"><tr><td align="center">
+    %diagram%
+  </td></tr></table>
+ENDIF:diagram
+
+IF:description
+  <div class="description">%description%</div>
+ENDIF:description
+
+IF:requires
+  <div class="sectiontitle">Required Files</div>
+  <ul>
+START:requires
+  <li>HREF:aref:name:</li>
+END:requires
+  </ul>
+ENDIF:requires
+
+IF:toc
+  <div class="sectiontitle">Contents</div>
+  <ul>
+START:toc
+  <li><a href="#%href%">%secname%</a></li>
+END:toc
+  </ul>
+ENDIF:toc
+
+IF:methods
+  <div class="sectiontitle">Methods</div>
+  <ul>
+START:methods
+  <li>HREF:aref:name:</li>
+END:methods
+  </ul>
+ENDIF:methods
+
+IF:includes
+<div class="sectiontitle">Included Modules</div>
+<ul>
+START:includes
+  <li>HREF:aref:name:</li>
+END:includes
+</ul>
+ENDIF:includes
+
+START:sections
+IF:sectitle
+<div class="sectiontitle"><a nem="%secsequence%">%sectitle%</a></div>
+IF:seccomment
+<div class="description">
+%seccomment%
+</div>
+ENDIF:seccomment
+ENDIF:sectitle
+
+IF:classlist
+  <div class="sectiontitle">Classes and Modules</div>
+  %classlist%
+ENDIF:classlist
+
+IF:constants
+  <div class="sectiontitle">Constants</div>
+  <table border='0' cellpadding='5'>
+START:constants
+  <tr valign='top'>
+    <td class="attr-name">%name%</td>
+    <td>=</td>
+    <td class="attr-value">%value%</td>
+  </tr>
+IF:desc
+  <tr valign='top'>
+    <td>&nbsp;</td>
+    <td colspan="2" class="attr-desc">%desc%</td>
+  </tr>
+ENDIF:desc
+END:constants
+  </table>
+ENDIF:constants
+
+IF:attributes
+  <div class="sectiontitle">Attributes</div>
+  <table border='0' cellpadding='5'>
+START:attributes
+  <tr valign='top'>
+    <td class='attr-rw'>
+IF:rw
+[%rw%]
+ENDIF:rw
+    </td>
+    <td class='attr-name'>%name%</td>
+    <td class='attr-desc'>%a_desc%</td>
+  </tr>
+END:attributes
+  </table>
+ENDIF:attributes
+
+IF:method_list
+START:method_list
+IF:methods
+<div class="sectiontitle">%type% %category% methods</div>
+START:methods
+<div class="method">
+  <div class="title">
+IF:callseq
+    <a name="%aref%"></a><b>%callseq%</b>
+ENDIF:callseq
+IFNOT:callseq
+    <a name="%aref%"></a><b>%name%</b>%params%
+ENDIF:callseq
+IF:codeurl
+[ <a href="javascript:openCode('%codeurl%')">source</a> ]
+ENDIF:codeurl
+  </div>
+IF:m_desc
+  <div class="description">
+  %m_desc%
+  </div>
+ENDIF:m_desc
+IF:aka
+<div class="aka">
+  This method is also aliased as
+START:aka
+  <a href="%aref%">%name%</a>
+END:aka
+</div>
+ENDIF:aka
+IF:sourcecode
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('%aref%_source')" id="l_%aref%_source">show source</a> ]</p>
+  <div id="%aref%_source" class="dyn-source">
+<pre>
+%sourcecode%
+</pre>
+  </div>
+</div>
+ENDIF:sourcecode
+</div>
+END:methods
+ENDIF:methods
+END:method_list
+ENDIF:method_list
+END:sections
+</div>
+HTML
+
+FOOTER = <<ENDFOOTER
+  </body>
+</html>
+ENDFOOTER
+
+BODY = HEADER + <<ENDBODY
+  !INCLUDE! <!-- banner header -->
+
+  <div id="bodyContent">
+    #{METHOD_LIST}
+  </div>
+
+  #{FOOTER}
+ENDBODY
+
+########################## Source code ##########################
+
+SRC_PAGE = XHTML_PREAMBLE + <<HTML
+<html>
+<head><title>%title%</title>
+<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+<style>
+.ruby-comment    { color: green; font-style: italic }
+.ruby-constant   { color: #4433aa; font-weight: bold; }
+.ruby-identifier { color: #222222;  }
+.ruby-ivar       { color: #2233dd; }
+.ruby-keyword    { color: #3333FF; font-weight: bold }
+.ruby-node       { color: #777777; }
+.ruby-operator   { color: #111111;  }
+.ruby-regexp     { color: #662222; }
+.ruby-value      { color: #662222; font-style: italic }
+  .kw { color: #3333FF; font-weight: bold }
+  .cmt { color: green; font-style: italic }
+  .str { color: #662222; font-style: italic }
+  .re  { color: #662222; }
+</style>
+</head>
+<body bgcolor="white">
+<pre>%code%</pre>
+</body>
+</html>
+HTML
+
+########################## Index ################################
+
+FR_INDEX_BODY = <<HTML
+!INCLUDE!
+HTML
+
+FILE_INDEX = XHTML_PREAMBLE + <<HTML
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+<style>
+<!--
+  body {
+    background-color: #EEE;
+    font-family: #{FONTS}; 
+    color: #000;
+    margin: 0px;
+  }
+  .banner {
+    background: #005;
+    color: #FFF;
+    padding: 0.2em;
+    font-size: small;
+    font-weight: bold;
+    text-align: center;
+  }
+  .entries {
+    margin: 0.25em 1em 0 1em;
+    font-size: x-small;
+  }
+  a {
+    color: #00F;
+    text-decoration: none;
+    white-space: nowrap;
+  }
+  a:hover {
+    color: #77F;
+    text-decoration: underline;
+  }
+-->
+</style>
+<base target="docwin">
+</head>
+<body>
+<div class="banner">%list_title%</div>
+<div class="entries">
+START:entries
+<a href="%href%">%name%</a><br>
+END:entries
+</div>
+</body></html>
+HTML
+
+CLASS_INDEX = FILE_INDEX
+METHOD_INDEX = FILE_INDEX
+
+INDEX = XHTML_PREAMBLE + <<HTML
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>%title%</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+</head>
+
+<frameset cols="20%,*">
+    <frameset rows="15%,35%,50%">
+        <frame src="fr_file_index.html"   title="Files" name="Files" />
+        <frame src="fr_class_index.html"  name="Classes" />
+        <frame src="fr_method_index.html" name="Methods" />
+    </frameset>
+IF:inline_source
+      <frame  src="%initial_page%" name="docwin">
+ENDIF:inline_source
+IFNOT:inline_source
+    <frameset rows="80%,20%">
+      <frame  src="%initial_page%" name="docwin">
+      <frame  src="blank.html" name="source">
+    </frameset>
+ENDIF:inline_source
+    <noframes>
+          <body bgcolor="white">
+            Click <a href="html/index.html">here</a> for a non-frames
+            version of this page.
+          </body>
+    </noframes>
+</frameset>
+
+</html>
+HTML
+
+end
+end
+
+