olag 0.1.15 → 0.1.16

data/ChangeLog

@@ -1,5 +1,6 @@
 2012-01-07	Oren Ben-Kiki <github-oren@ben-kiki.org>
 
+	* Improve HAskell configuration comment.
 	* Add default configurations for Haskell code.
 
 2011-09-13	Oren Ben-Kiki <github-oren@ben-kiki.org>

data/codnar.html

@@ -679,8 +679,7 @@ Olag using monkey-patching.
 <p>
 Finally, Olag::Rake sets up the following tasks (as reported by <code>rake -T</code>):
 </p>
-<pre>
-<code>rake all               # Version, verify, document, package
+<pre><code>rake all               # Version, verify, document, package
 rake analyze           # Analyze source code
 rake changelog         # Update ChangeLog from Git
 rake clean             # Remove any temporary products.
@@ -710,9 +709,7 @@ rake second_commit     # Perform the 2nd (amend) Git commit
 rake test              # Run tests for test
 rake verify            # Test, coverage, analyze code
 rake version           # Update version file from Git
-</code>
-</pre>
-</li>
+</code></pre></li>
 </ul>
 
 
@@ -2028,7 +2025,7 @@ number of Git commits by running <tt>rake version</tt>.
 </tr>
 </table>
 <pre class='ruby code syntax'>
-  <span class="Type">VERSION</span> = <span class="Special">&quot;</span><span class="Constant">0.1.15</span><span class="Special">&quot;</span>
+  <span class="Type">VERSION</span> = <span class="Special">&quot;</span><span class="Constant">0.1.16</span><span class="Special">&quot;</span>
 
 end
 </pre>
@@ -3305,6 +3302,7 @@ Here is a mix-in that helps writing tests using temporary files and folders:
 <div class="chunk html">
 <pre class='ruby code syntax'>
 <span class="PreProc">require</span> <span class="Special">&quot;</span><span class="Constant">fileutils</span><span class="Special">&quot;</span>
+<span class="PreProc">require</span> <span class="Special">&quot;</span><span class="Constant">tempfile</span><span class="Special">&quot;</span>
 
 <span class="PreProc">module</span> <span class="Type">Test</span>
 
@@ -3423,8 +3421,106 @@ Automatically clean up the temporary files when the test is done.
         <span class="PreProc">end</span>
 
       end
+    end
+
+  end
+
+end
+</pre>
+</div>
+</div>
+</p>
+<h3>Testing with a temporary directory</h3>
+<p>
+When running external programs, or sometimes even Ruby programs, it is useful
+to have a temporary directory to stuff everything into, which is automatically
+removed when the test is done. The <code>WithTempfile</code> module does provide the
+<code>create_tempdir</code> function, which we can use; but it is easier to also include
+the <code>WithTempdir</code> module, which does this automatically in the <code>setup</code> function
+for us, and precomputes up the standard I/O file names as well.
+</p>
+<p>
+<div class="named_with_containers chunk">
+<div class="chunk name">
+<a name="lib-olag-test-with-tempdir-rb">
+<span>lib/olag/test/with_tempdir.rb</span>
+</a>
+</div>
+<div class="chunk html">
+<pre class='ruby code syntax'>
+<span class="PreProc">require</span> <span class="Special">&quot;</span><span class="Constant">olag/test/with_tempfile</span><span class="Special">&quot;</span>
+
+<span class="PreProc">module</span> <span class="Type">Test</span>
+
+</pre>
+  <table class='layout'>
+<tr>
+<td class='indentation'>
+<pre>  </pre>
+</td>
+<td class='html'>
+<div class='rdoc comment markup'>
+<p>
+Mix-in for tests that run applications in a temporary directory. This
+assumes that the test class has already mixed-in the WithTempfile mix-in.
+</p>
+</div>
+</td>
+</tr>
+</table>
+<pre class='ruby code syntax'>
+  <span class="PreProc">module</span> <span class="Type">WithTempdir</span>
+
+</pre>
+    <table class='layout'>
+<tr>
+<td class='indentation'>
+<pre>    </pre>
+</td>
+<td class='html'>
+<div class='rdoc comment markup'>
+<p>
+Aliasing methods needs to be deferred to when the module is included and be
+executed in the context of the class.
+</p>
+</div>
+</td>
+</tr>
+</table>
+<pre class='ruby code syntax'>
+    <span class="PreProc">def</span> <span class="Constant">self</span>.<span class="Identifier">included</span>(base)
+      base.class_eval <span class="Statement">do</span>
+
+        alias_method <span class="Constant">:tempdir_original_setup</span>, <span class="Constant">:setup</span>
 
+</pre>
+        <table class='layout'>
+<tr>
+<td class='indentation'>
+<pre>        </pre>
+</td>
+<td class='html'>
+<div class='rdoc comment markup'>
+<p>
+Create a temporary directory for the run and percompute the standard I/O
+file names in it.
+</p>
+</div>
+</td>
+</tr>
+</table>
+<pre class='ruby code syntax'>
+        <span class="PreProc">def</span> <span class="Identifier">setup</span>
+          tempdir_original_setup
+          <span class="Identifier">@tempdir</span> = create_tempdir
+          <span class="Identifier">@stdout</span> = <span class="Identifier">@tempdir</span> + <span class="Special">&quot;</span><span class="Constant">/stdout</span><span class="Special">&quot;</span>
+          <span class="Identifier">@stdin</span> = <span class="Identifier">@tempdir</span> + <span class="Special">&quot;</span><span class="Constant">/stdin</span><span class="Special">&quot;</span>
+          <span class="Identifier">@stderr</span> = <span class="Identifier">@tempdir</span> + <span class="Special">&quot;</span><span class="Constant">/stderr</span><span class="Special">&quot;</span>
+        <span class="PreProc">end</span>
+
+      end
     end
+
   end
 
 end

data/doc/system.markdown

@@ -242,6 +242,17 @@ Here is a mix-in that helps writing tests using temporary files and folders:
 
 [[lib/olag/test/with_tempfile.rb|named_chunk_with_containers]]
 
+### Testing with a temporary directory ###
+
+When running external programs, or sometimes even Ruby programs, it is useful
+to have a temporary directory to stuff everything into, which is automatically
+removed when the test is done. The `WithTempfile` module does provide the
+`create_tempdir` function, which we can use; but it is easier to also include
+the `WithTempdir` module, which does this automatically in the `setup` function
+for us, and precomputes up the standard I/O file names as well.
+
+[[lib/olag/test/with_tempdir.rb|named_chunk_with_containers]]
+
 ### Testing Rake tasks ###
 
 Testing Rake tasks is tricky because tests may be run in the context of Rake.

data/lib/olag/test/with_tempdir.rb

@@ -0,0 +1,31 @@
+require "olag/test/with_tempfile"
+
+module Test
+
+  # Mix-in for tests that run applications in a temporary directory. This
+  # assumes that the test class has already mixed-in the WithTempfile mix-in.
+  module WithTempdir
+
+    # Aliasing methods needs to be deferred to when the module is included and
+    # be executed in the context of the class.
+    def self.included(base)
+      base.class_eval do
+
+        alias_method :tempdir_original_setup, :setup
+
+        # Create a temporary directory for the run and percompute the standard
+        # I/O file names in it.
+        def setup
+          tempdir_original_setup
+          @tempdir = create_tempdir
+          @stdout = @tempdir + "/stdout"
+          @stdin = @tempdir + "/stdin"
+          @stderr = @tempdir + "/stderr"
+        end
+
+      end
+    end
+
+  end
+
+end

data/lib/olag/test/with_tempfile.rb

@@ -1,4 +1,5 @@
 require "fileutils"
+require "tempfile"
 
 module Test
 
@@ -42,8 +43,8 @@ module Test
         end
 
       end
-
     end
+
   end
 
 end

data/lib/olag/version.rb

@@ -3,6 +3,6 @@ module Olag
 
   # This version number. The third number is automatically updated to track the
   # number of Git commits by running <tt>rake version</tt>.
-  VERSION = "0.1.15"
+  VERSION = "0.1.16"
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: olag
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 59
   prerelease: 
   segments: 
   - 0
   - 1
-  - 15
-  version: 0.1.15
+  - 16
+  version: 0.1.16
 platform: ruby
 authors: 
 - Oren Ben-Kiki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-07 00:00:00 Z
+date: 2012-01-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: Saikuro
@@ -180,6 +180,7 @@ files:
 - lib/olag/test/with_errors.rb
 - lib/olag/test/with_fakefs.rb
 - lib/olag/test/with_rake.rb
+- lib/olag/test/with_tempdir.rb
 - lib/olag/test/with_tempfile.rb
 - lib/olag/test.rb
 - lib/olag/update_version.rb
@@ -202,7 +203,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Olag 0.1.15
+- Olag 0.1.16
 - --main
 - README.rdoc
 - --line-numbers