ariete 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+Ariete $stdout & $stderr Capture Module
+=======================================
+
+## Ver 0.0.1
+
+- 2012/12/10
+- First release

data/CHANGELOG_jp.md

@@ -0,0 +1,7 @@
+Ariete $stdout & $stderr Capture Module
+=======================================
+
+## Ver 0.0.1
+
+- 2012/12/10
+- ファーストリリース。

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Moza USANE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+Ariete $stdout & $stderr Capture Module
+=======================================
+
+## Introduction
+
+Ariete $stdout & $stderr Capture Module is a module that captures $stdout($stderr) and return as String. Ariete is useful on unit test.
+
+**usage**
+
+    require "test/unit"
+    require_relative "klass"
+
+    class KlassTest < Test::Unit::TestCase
+      include Ariete
+
+      def test_stdout
+        result = capture_stdout {Klass.output_out("Ariete")}
+        assert_equal("Ariete is a kind of rabbit.", result)
+      end
+
+      def test_stderr
+        result = capture_stderr {Klass.output_err("Ariete")}
+        assert_equal("Ariete means 'Lop' in Italian.", result)
+      end
+    end            
+
+## Operation Environment
+
+We checked good operation within following environment.
+
+- Linux（openSUSE 12.2）・Mac OS X 10.8.2
+- Ruby 1.9.3
+
+## Architectonics
+
+- **bin**
+- **doc** :: Documents generated by rdoc
+- **lib**
+  - **ariete.rb** :: Main unit of Ariete
+- **LICENSE**
+- **Rakefile** :: Rakefile that is used to generate gem file
+- **README.md**
+- **README_jp.md**
+- **test** :: Unit tests
+  - **tb_capture_std.rb** :: Unit test for Ariete
+  
+## Install
+
+Download ariete-x.y.z.gem, then execute following command to install Ariete.
+
+`$ sudo gem install ariete-x.y.z.gem`
+
+On the other hand, you can install from RubyGems.org to use following command.
+
+`$ sudo gem install ariete`
+
+## Sample code
+
+See tb_capture_std.rb file. It is an unit test code, and it doubles with sample code.
+
+## API document
+
+See following website: [http://quellencode.org/ariete-doc/](http://quellencode.org/ariete-doc/ "")
+
+## License
+
+Hakto is distributed with MIT License. See the LICENSE file to read the detail of license.
+
+## About Author
+
+Moza USANE  
+[http://blog.quellencode.org/](http://blog.quellencode.org/ "")  
+mozamimy@quellencode.org

data/README_jp.md

@@ -0,0 +1,73 @@
+Ariete $stdout & $stderr Capture Module
+=======================================
+
+## イントロダクション
+
+Ariete $stdout & $stderr Capture Moduleは、標準出力または標準エラー出力をキャプチャし、文字列として取得するためのモジュールである。主にユニットテストで使用することを想定している。
+
+**usage**
+
+    require "test/unit"
+    require_relative "klass"
+
+    class KlassTest < Test::Unit::TestCase
+      include Ariete
+
+      def test_stdout
+        result = capture_stdout {Klass.output_out("Ariete")}
+        assert_equal("Ariete is a kind of rabbit.", result)
+      end
+
+      def test_stderr
+        result = capture_stderr {Klass.output_err("Ariete")}
+        assert_equal("Ariete means 'Lop' in Italian.", result)
+      end
+    end  
+
+## 動作環境
+
+以下の環境で開発およびテストをしている。
+
+- Linux（openSUSE 12.2）・Mac OS X 10.8.2
+- Ruby 1.9.3
+
+## 構成
+
+- **bin**
+- **doc** :: rdocによるドキュメント
+- **lib**
+  - **ariete.rb** :: モジュール本体
+- **LICENSE**
+- **Rakefile** :: gemパッケージ生成用のRakefile
+- **README.md**
+- **README_jp.md**
+- **test** :: ユニットテスト
+  - **tb_capture_std.rb** :: ariete.rbのためのユニットテスト
+
+## インストール
+
+ariete-x.y.z.gemファイル（x、y、zはバージョン番号）をダウンロードし、以下のコマンドを入力してインストールする。
+
+`$ sudo gem install ariete-x.y.z.gem`
+
+または、RubyGems.orgからgemコマンドを使ってインストールすることもできる。
+
+`$ sudo gem install ariete`
+
+## サンプルコード
+
+tb_capture_std.rbがサンプルコードを兼ねている。
+
+## APIドキュメント
+
+[http://quellencode.org/ariete-doc/](http://quellencode.org/ariete-doc/ "")を参照
+
+## ライセンス
+
+本ソフトウェアは、MIT Licenseのもとで配布されている。詳細はLICENSEファイルに記している。
+
+## 作者について
+
+Moza USANE  
+[http://blog.quellencode.org/](http://blog.quellencode.org/ "")  
+mozamimy@quellencode.org

data/Rakefile

@@ -0,0 +1,18 @@
+require "rake/gempackagetask"
+
+spec = Gem::Specification.new do |s|
+  s.name         = "ariete"
+  s.summary      = "Ariete $stdout & $stderr Capture Module."
+  s.description  = File.read(File.join(File.dirname(__FILE__), "README.md"))
+  s.version      = "0.0.1"
+  s.author       = "Moza USANE"
+  s.email        = "mozamimy@quellencode.org"
+  s.homepage     = "http://blog.quellencode.org/"
+  s.platform     = Gem::Platform::RUBY
+  s.required_ruby_version = ">=1.9"
+  s.files        = Dir["**/**"]
+  s.test_files   = Dir["test/test*.rb"]
+  s.has_rdoc     = true
+end
+
+Rake::GemPackageTask.new(spec).define

data/doc/Ariete.html

@@ -0,0 +1,248 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Module: Ariete</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="module">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/ariete_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/ariete.rb">lib/ariete.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+
+      
+
+      
+
+      
+      <!-- Method Quickref -->
+      <div id="method-list-section" class="section">
+        <h3 class="section-header">Methods</h3>
+        <ul class="link-list">
+          
+          <li><a href="#method-i-capture_stderr">#capture_stderr</a></li>
+          
+          <li><a href="#method-i-capture_stdout">#capture_stdout</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./LICENSE.html">LICENSE</a></li>
+        
+          <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./Ariete.html">Ariete</a></li>
+        
+          <li><a href="./CaptureStdTest.html">CaptureStdTest</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="module">Ariete</h1>
+
+    <div id="description" class="description">
+      
+<p><a href="Ariete.html">Ariete</a> $stdout &amp; $stderr Capture Module</p>
+<table class="rdoc-list"><tr><td class="rdoc-term"><p>Author</p></td>
+<td>
+<p>Moza USANE (<a
+href="mailto:mozamimy@quellencode.org">mozamimy@quellencode.org</a>)</p>
+</td></tr><tr><td class="rdoc-term"><p>Copyright</p></td>
+<td>
+<p>Copyright © 2012 Moza USANE</p>
+</td></tr><tr><td class="rdoc-term"><p>License</p></td>
+<td>
+<p>MIT License (see the <a href="LICENSE.html">LICENSE</a> file)</p>
+</td></tr></table>
+
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+
+      
+
+      <!-- Methods -->
+      
+      <div id="public-instance-method-details" class="method-section section">
+        <h3 class="section-header">Public Instance Methods</h3>
+
+      
+        <div id="capture_stderr-method" class="method-detail ">
+          <a name="method-i-capture_stderr"></a>
+
+          
+          <div class="method-heading">
+            <span class="method-name">capture_stderr</span><span
+              class="method-args"></span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          
+
+          <div class="method-description">
+            
+            <p>Capture $stderr’s output and return as String.</p>
+
+<h4>Args</h4>
+<table class="rdoc-list"><tr><td class="rdoc-term"><p>&amp;block </p></td>
+<td>
+<p>a block that you want to capture</p>
+</td></tr></table>
+
+<h4>Return</h4>
+
+<p>Captured string</p>
+            
+
+            
+            <div class="method-source-code" id="capture_stderr-source">
+<pre>
+<span class="ruby-comment"># File lib/ariete.rb, line 27</span>
+    </pre>
+            </div><!-- capture_stderr-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- capture_stderr-method -->
+
+      
+        <div id="capture_stdout-method" class="method-detail ">
+          <a name="method-i-capture_stdout"></a>
+
+          
+          <div class="method-heading">
+            <span class="method-name">capture_stdout</span><span
+              class="method-args"></span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          
+
+          <div class="method-description">
+            
+            <p>Capture $stdout’s output and return as String.</p>
+
+<h4>Args</h4>
+<table class="rdoc-list"><tr><td class="rdoc-term"><p>&amp;block </p></td>
+<td>
+<p>a block that you want to capture</p>
+</td></tr></table>
+
+<h4>Return</h4>
+
+<p>Captured string</p>
+            
+
+            
+            <div class="method-source-code" id="capture_stdout-source">
+<pre>
+<span class="ruby-comment"># File lib/ariete.rb, line 19</span>
+    </pre>
+            </div><!-- capture_stdout-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- capture_stdout-method -->
+
+      
+      </div><!-- public-instance-method-details -->
+    
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+

data/doc/CaptureStdTest.html

@@ -0,0 +1,277 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Class: CaptureStdTest</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="class">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./test/tb_capture_std_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="test/tb_capture_std.rb">test/tb_capture_std.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+      <!-- Parent Class -->
+      <div id="parent-class-section" class="section">
+        <h3 class="section-header">Parent</h3>
+        
+        <p class="link">Test::Unit::TestCase</p>
+        
+      </div>
+      
+
+      
+
+      
+
+      
+      <!-- Method Quickref -->
+      <div id="method-list-section" class="section">
+        <h3 class="section-header">Methods</h3>
+        <ul class="link-list">
+          
+          <li><a href="#method-i-output">#output</a></li>
+          
+          <li><a href="#method-i-test_stderr">#test_stderr</a></li>
+          
+          <li><a href="#method-i-test_stdout">#test_stdout</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+      <!-- Included Modules -->
+      <div id="includes-section" class="section">
+        <h3 class="section-header">Included Modules</h3>
+        <ul class="link-list">
+        
+        
+          <li><a class="include" href="Ariete.html">Ariete</a></li>
+        
+        
+        </ul>
+      </div>
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./LICENSE.html">LICENSE</a></li>
+        
+          <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./Ariete.html">Ariete</a></li>
+        
+          <li><a href="./CaptureStdTest.html">CaptureStdTest</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="class">CaptureStdTest</h1>
+
+    <div id="description" class="description">
+      
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+
+      
+
+      <!-- Methods -->
+      
+      <div id="public-instance-method-details" class="method-section section">
+        <h3 class="section-header">Public Instance Methods</h3>
+
+      
+        <div id="output-method" class="method-detail ">
+          <a name="method-i-output"></a>
+
+          
+          <div class="method-heading">
+            <span class="method-name">output</span><span
+              class="method-args">(str)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          
+
+          <div class="method-description">
+            
+            
+            
+
+            
+            <div class="method-source-code" id="output-source">
+<pre>
+<span class="ruby-comment"># File test/tb_capture_std.rb, line 18</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">output</span>(<span class="ruby-identifier">str</span>)
+  <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;#{str} is a kind of rabbit.&quot;</span>
+  <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;#{str} means 'Lop' in Italian&quot;</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- output-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- output-method -->
+
+      
+        <div id="test_stderr-method" class="method-detail ">
+          <a name="method-i-test_stderr"></a>
+
+          
+          <div class="method-heading">
+            <span class="method-name">test_stderr</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          
+
+          <div class="method-description">
+            
+            
+            
+
+            
+            <div class="method-source-code" id="test_stderr-source">
+<pre>
+<span class="ruby-comment"># File test/tb_capture_std.rb, line 13</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">test_stderr</span>
+  <span class="ruby-identifier">result</span> = <span class="ruby-identifier">capture_stderr</span> {<span class="ruby-identifier">output</span>(<span class="ruby-string">&quot;Ariete&quot;</span>)}
+  <span class="ruby-identifier">assert_equal</span>(<span class="ruby-string">&quot;Ariete means 'Lop' in Italian\n&quot;</span>, <span class="ruby-identifier">result</span>)
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- test_stderr-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- test_stderr-method -->
+
+      
+        <div id="test_stdout-method" class="method-detail ">
+          <a name="method-i-test_stdout"></a>
+
+          
+          <div class="method-heading">
+            <span class="method-name">test_stdout</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          
+
+          <div class="method-description">
+            
+            
+            
+
+            
+            <div class="method-source-code" id="test_stdout-source">
+<pre>
+<span class="ruby-comment"># File test/tb_capture_std.rb, line 8</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">test_stdout</span>
+  <span class="ruby-identifier">result</span> = <span class="ruby-identifier">capture_stdout</span> {<span class="ruby-identifier">output</span>(<span class="ruby-string">&quot;Ariete&quot;</span>)}
+  <span class="ruby-identifier">assert_equal</span>(<span class="ruby-string">&quot;Ariete is a kind of rabbit.\n&quot;</span>, <span class="ruby-identifier">result</span>)
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- test_stdout-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- test_stdout-method -->
+
+      
+      </div><!-- public-instance-method-details -->
+    
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+